docsify
pages-gem
Our great sponsors
docsify | pages-gem | |
---|---|---|
29 | 586 | |
26,561 | 1,808 | |
1.2% | 0.7% | |
8.2 | 8.1 | |
6 days ago | about 1 month ago | |
JavaScript | Ruby | |
MIT License | MIT License |
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
pages-gem
-
How to build your interactive resume in 4 simple and 2 easy steps
It's super easy to publish a static site like the resume with GitHub Pages. Just check out the docs.
-
100+ FREE Resources Every Web Developer Must Try
GitHub Pages: Host your static websites directly from your GitHub repository.
-
Ask HN: Looking for lightweight personal blogging platform
As per many other comments, it sounds like a static site generator like Hugo (https://gohugo.io/) or Jekyll (https://jekyllrb.com/), hosted on GitHub Pages (https://pages.github.com/) or GitLab Pages (https://about.gitlab.com/stages-devops-lifecycle/pages/), would be a good match. If you set up GitHub Actions or GitLab CI/CD to do the build and deploy (see e.g. https://gohugo.io/hosting-and-deployment/hosting-on-github/), your normal workflow will simply be to edit markdown and do a git push to make your changes live. There are a number of pre-built themes (e.g. https://themes.gohugo.io/) you can use, and these are realtively straightforward to tweak to your requirements.
-
Top 20 Free Static Web Hosting Services in 2024 ⚡️
Ideal for open source projects, docs sites, and portfolios. GitHub Pages
-
Creating an Engaging Curriculum vitae using Github Pages: A Step-by-Step Guide
Github Pages: Link to Github Pages
-
Different Levels of Project Documentation
Once you have all the documentation worked out a place to host it will be necessary. Some documentation generation may have ties in with specific hosting sites. Read The Docs' support for Sphinx and other documentation tools is one example. GitHub pages can be useful for GitHub hosted projects as it integrates well with GitHub Actions CI/CD deployments.
-
The minimalist guide to deploying a website in 2023 🧘
If you use GitHub and need to host a static website, consider GitHub Pages. Free for one site Stored on a GitHub public respository Deploy via web interface, or Git 100GB/month free bandwidth
-
I made a simple website 100% for FREE! 🤯
https://pages.github.com/ https://docs.github.com/en/pages https://docs.github.com/en/pages/quickstart https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll
-
How to host my own website from GitHub
There are plenty of other hosting options you could use instead, such as GitHub Pages.
-
A page to see all revealed Affliction Gems at once
Functionally github.io just presents whatever you throw into the repository as the root directory of a site, github themselves host a very good, basic outline of how to set up a site on github.io.
What are some alternatives?
Docusaurus - Easy to maintain open source documentation websites.
al-folio - A beautiful, simple, clean, and responsive Jekyll theme for academics
VuePress - 📝 Minimalistic Vue-powered static site generator
neocities - Neocities.org - the web site. The entire thing. Yep, we're completely open source.
front-matter - Extract YAML front matter from strings
Jekyll - :globe_with_meridians: Jekyll is a blog-aware static site generator in Ruby
MkDocs - Project documentation with Markdown.
Hugo - The world’s fastest framework for building websites.
BookStack - A platform to create documentation/wiki content built with PHP & Laravel
typedoc - Documentation generator for TypeScript projects.
git - A fork of Git containing Windows-specific patches.