gh-pages
docsify
gh-pages | docsify | |
---|---|---|
21 | 29 | |
3,181 | 26,658 | |
- | 1.0% | |
7.3 | 8.2 | |
6 days ago | 4 days ago | |
JavaScript | JavaScript | |
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.
gh-pages
-
How to deploy to GitHub Pages using gh-pages package
1) First setup GitHub Pages on the GitHub quickstart 2) Install gh-pages package. It can be installed to devDependencies. NPM
-
Github pages-like hosting but on a custom domain?
I think this is what you're looking for: https://www.npmjs.com/package/gh-pages and then scroll towards the bottom, and you can set it up to run using a script in your package.json file using npm run deploy
-
[Solved] React app bundled with Parcel would not deploy correctly in GitHub Pages
After that I turned to a package called gh-pages, which pushed the bundled files to a new branch and deployed the Github Pages website from there, and I gave it a try.
-
What I learned from self-hosting a Supabase Svelte project: Part 2
To automate this process, there is an npm package called gh-pages. It enables you to deploy your new version of the build, which is inside the dist folder for Svelte projects, to a new branch. Then if you configure your GitHub page to deploy that branch, this would automatically be deployed.
-
Multiple repositories Pull Request chaos, crawl them all in one single place
Generate App: this action aims to build and copy the React web application inside your repository and publish it using gh-pages NPM tool.
- Github-pages usando gh-pages y Vite
-
Deploying Your CRA React App on Github Pages
It will create a branch named gh-pages and (after a few steps that I’ll go through in the next section) automatically update that branch with new files whenever you run npm run deploy. If you want the details on everything going on behind the scenes here, check out the gh-pages docs.
-
Custom Domain removed after deploy with Github pages?
I had this too, its a bug with Github... the fix is listed here about half way down: https://github.com/tschaub/gh-pages/issues/213
-
Creating a resume on GitHub via vscode.dev
GitHub pages are pretty nifty. The https://github.com/tschaub/gh-pages package complements it nicely for those wiching for a stronger local development experience.
- Haciendo deploy de una app en react a GitHub Pages
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
What are some alternatives?
parcel - The zero configuration build tool for the web. 📦🚀
Docusaurus - Easy to maintain open source documentation websites.
wrangler-legacy - 🤠 Home to Wrangler v1 (deprecated)
VuePress - 📝 Minimalistic Vue-powered static site generator
skynet-webportal - A webapp that makes Skynet accessible to web browsers.
front-matter - Extract YAML front matter from strings
react-router - Declarative routing for React
MkDocs - Project documentation with Markdown.
letsencrypt - Certbot is EFF's tool to obtain certs from Let's Encrypt and (optionally) auto-enable HTTPS on your server. It can also act as a client for any other CA that uses the ACME protocol.
BookStack - A platform to create documentation/wiki content built with PHP & Laravel
netlify-identity-widget - A zero config, framework free Netlify Identity widget
typedoc - Documentation generator for TypeScript projects.