just-the-docs
jekyll-theme-chirpy
Our great sponsors
just-the-docs | jekyll-theme-chirpy | |
---|---|---|
17 | 8 | |
6,915 | 6,041 | |
2.9% | - | |
8.4 | 9.3 | |
4 days ago | 5 days ago | |
SCSS | HTML | |
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.
just-the-docs
-
Gojekyll β 20x faster Go port of jekyll
I think GitHub Pages only supports a whitelist of plugins, so you might have some more difficulties solving it well without any plugins. I use Netlify for my site, which does support arbitrary plugins.
One quick way to make it faster is to include that "_includes/nav.html" only in a nav.html, and then use an iframe to load that on every page, or something like that.
Anyway, I'm not the first to notice this it seems, although even "twice as fast" would still be quite slow: https://github.com/just-the-docs/just-the-docs/issues/1323
Neat, thanks for noticing, the theme is basically a slightly simplified version of https://github.com/just-the-docs/just-the-docs, never suspected it was an issue with it, I'll take a look to see what can I fix!
-
Having the rules and mechanics easily accessible in a webpage/site.
If it can help, there was a commenter earlier who suggested trying out a Doc-style github page that you can easily fork. It also has its own built-in search. Comment here. Github page here.
- Is legit to use Github pages for non-coding purposes?
- Keep your diagrams updated with continuous delivery
-
Open Source Like
That's certainly an option. Games like Liminal Horror and Into the Dungeon Revived host versions on GitHub. You can then render it to a GitHub.io page using something like Just the Docs.
-
Ask HN: What do people use for documentation sites these days?
https://pmarsceill.github.io/just-the-docs/
Especially if you're already familiar with Jekyll. Bonus points for being able to deploy on GitHub Pages!
-
Tags-based documentation build (contextual documentation)
You can use 'Just the Docs' (https://github.com/pmarsceill/just-the-docs) for documentation - it's a Jekyll-based theme for documentation and has built-in search.
-
Which tools did you use to design yours cloud architecture ?
Yeah, itβs just a visualization for the configuration in the repository. I also have a repository that utilizes GitHub Pages hosting for more generalized account level documentation and diagrams (Just the Docs is a great theme for this).
- Ask HN: What are you using for public documentation these days?
jekyll-theme-chirpy
-
Where are the layouts!? And where is the site object loaded from? (Chirpy Theme)
"Using the Chirpy theme for Jekyll."
-
Simple selfhosted note taking
If you wanted it to be EXACTLY like TechnoTim's docs site, you could use Jekyll with Chirpy theme (I viewed the source to figure out how it was made).
-
Dealing with Merge Conflicts and Upstream Branches (Git/GitHub)
I made a simple personal website using this Jekyll theme, generated from this template, and deployed in it using GitHub Pages. This repo was not generated from a fork.
What are some alternatives?
Read the Docs - The source code that powers readthedocs.org
MkDocs - Project documentation with Markdown.
chirpy-starter - The startup template for Chirpy.
Docusaurus - Easy to maintain open source documentation websites.
jekyll-docker - β΄ Docker images, and CI builders for Jekyll.
primer - Primer is a Jekyll theme for GitHub Pages
jekyll-theme-hamilton - A minimal and beautiful Jekyll theme best for writing and note-taking.
long-haul - A minimal, type-focused Jekyll theme.
typedoc - Documentation generator for TypeScript projects.
mdBook - Create book from markdown files. Like Gitbook but implemented in Rust
docsify - π A magical documentation site generator.
minima - Minima is a one-size-fits-all Jekyll theme for writers.