docsify
cobra
Our great sponsors
docsify | cobra | |
---|---|---|
29 | 129 | |
26,611 | 35,891 | |
1.2% | - | |
8.2 | 7.8 | |
1 day ago | 8 days ago | |
JavaScript | Go | |
MIT License | Apache License 2.0 |
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
docsify
-
Alternatives to Docusaurus for product documentation
Docsify is frequently updated; the latest release was on June 24, 2023, and the most recent update was on December 17, 2023. It is MIT-licensed and has an active Discord community.
-
Cookbook for SH-Beginners. Any interest? (building one)
okay new plan, does anyone know how to do this docsify on github? i obviously am a noob on github and recently on reddit. I'd like to help where i can but my knowlegde seems to be my handycap. i could provide you a trash-mail, if you need one, but i need a PO (product owner) to manage the git... i have no clue about this yet (pages and functions and stuff)
-
Ask HN: Any Sugestions for Proceures Documentation?
The tools to author it aren't that important, frankly. Ask your audience what they're most comfortable using and try to meet them there.
If the stakeholders are technical, you have more options. If they aren't, I hope you like Google Docs or Word, because if you give them anything other than that or a PDF, they'll probably complain. At worst, yeah, write it in a long Markdown text file and use tools like pandoc to transform that into other formats as needed.
If you do need a website and you're not generating enterprise-scale amounts of content (and it sounds like you're not) try things that let you avoid needing build steps and infrastructure if at all possible, so you can iterate and deploy changes with as little friction as you can.
Tools like Docsify[1] can take a pile of Markdown files and serve a site out of them, client- or server-side, without a static build step. Depending on the org, you can get away with GitHub's default rendering of Markdown in a repo. Most static site builds for stuff your scale are overengineered instances of premature optimization.
Past those initial hurdles, the format and tools challenges are all in maintenance. How can you:
- most easily keep the content up to date
- delegate updates as the staff grows or changes
- proactively distribute updates ASAP to the people who'd most benefit from receiving them
That's going to depend a lot more on who'll contribute updates, what their technical proficiency's like, and how they prefer to communicate. It might be a shared git repo and RSS or Slack notifications if they're comfortable with those things, and it might be a Google Doc and email if they're like most non-technical stakeholders.
1: https://docsify.js.org
- Docsify.js single-page apps are indexable on Google!
- Library / CMS / framework for documentation?
-
How to Build a Personal Webpage from Scratch (In 2022)
Big fan of https://docsify.js.org since theres no need to compile your static site. A small amount of js just renders markdown.
-
Example of Support Guide for End Users
If you are searching for examples of an arbitrary Jellyfin support site, visit https://travisflix.com/help/#/support (or help.travisflix.com which redirects to the /help/ URI of the TLD) to take a look at what I have done with docsify on Github Pages.
- Show HN: Markdown as Web Page/Site
-
Phabricator replacement? | Or OpenProject alternative? | issue tracking/code
*Leantime - Competitor to OP? Updated recently, uses Docsify, no demo :(
-
I'm a co-founder of an IT agency, and I need help with new ideas.
There are a lot of open-source projects that can help businesses to save time and money. For example, we created a Free Admin panel a few months ago https://github.com/altence/lightence-admin That's an example of free documentation generator https://github.com/docsifyjs/docsify There are a lot more examples. And I want to find an idea of some similar generic solutions that can help various types of businesses
cobra
-
The power of the CLI with Golang and Cobra CLI
We can use the flag with --date or -date, Go already does the automatic check. We can make our entire boilerplate with this approach, but let's make it a little easier and use the Cobra CLI package.
-
Build your own curl in Golang
In this tutorial, we'll walk through the process of creating a simple command-line tool similar to curl using Go and Cobra, a CLI library for Go.
-
Scripts should be written using the project main language
I use https://github.com/spf13/cobra religiously for this kind of thing - it handles all the annoying corner cases of parsing flags, and also has an intuitive notion of subcommands (with basic usage/help text generated) for picking which task you want to run with positional arguments.
-
Command Line Interface Guidelines
We recently chose cobra[1] to create a cli application. It comes with so many best practices already packaged like autocompletions, help texts etc. etc.
[1]: https://github.com/spf13/cobra
-
What 3rd-party libraries do you use often/all the time?
github.com/spf13/cobra
- O poder do CLI com Golang e Cobra CLI
-
How to read Cobra command line flag
I looked at the docs: https://cobra.dev/ ... and there are only examples on how to add new flags.
-
Dockerizing Golang CLI Tool - A Step-by-Step Guide
For installing Cobra-CLI you can go to Cobraor run go install github.com/spf13/cobra-cli@latest in the terminal.
-
Packaging Go for Arch Linux Tutorial
In my build phase, I compile the source to create a k3sup binary and I also run the binary to generate shell script completions. Give kudos to this functionality which comes from spf13/cobra Go library for CLIs.
-
Add License Headers to Your Code Files
NWA is a command-line tool built on cobra. Here's an overview of NWA's commands:
What are some alternatives?
Docusaurus - Easy to maintain open source documentation websites.
urfave/cli - A simple, fast, and fun package for building command line apps in Go
VuePress - 📝 Minimalistic Vue-powered static site generator
cli - CLI - A package for building command line app with go
front-matter - Extract YAML front matter from strings
kingpin - CONTRIBUTIONS ONLY: A Go (golang) command line and flag parser
MkDocs - Project documentation with Markdown.
kong - Kong is a command-line parser for Go
BookStack - A platform to create documentation/wiki content built with PHP & Laravel
go-flags - go command line option parser
typedoc - Documentation generator for TypeScript projects.
mitchellh/cli - A Go library for implementing command-line interfaces.