primer
just-the-docs
Our great sponsors
primer | just-the-docs | |
---|---|---|
1 | 17 | |
262 | 6,915 | |
2.7% | 2.9% | |
4.9 | 8.4 | |
24 days ago | 4 days ago | |
SCSS | SCSS | |
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.
primer
-
What's the easiest way to make a dark theme (like on 1st photo) for markdown files hosted on github pages? Please check comments for the full description
GitHub Pages usually works by building your website using a tool called Jekyll. This uses a theme -- it looks like that's Primer in your case -- which describes how websites are formatted, and how they're styled. You can follow their instructions on how to add your own CSS on top of that. Try doing * { color: red; } just to see if you can get your stylesheet working (it should turn all text red), and then go from there.
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?
What are some alternatives?
Read the Docs - The source code that powers readthedocs.org
MkDocs - Project documentation with Markdown.
jekyll-theme-chirpy - A minimal, responsive, and feature-rich Jekyll theme for technical writing.
Docusaurus - Easy to maintain open source documentation websites.
jekyll-docker - β΄ Docker images, and CI builders for Jekyll.
jekyll-theme-hamilton - A minimal and beautiful Jekyll theme best for writing and note-taking.
typedoc - Documentation generator for TypeScript projects.
mdBook - Create book from markdown files. Like Gitbook but implemented in Rust
docsify - π A magical documentation site generator.
juicefs - JuiceFS is a distributed POSIX file system built on top of Redis and S3.
LearnJavaForFTC - This is for learning Java for FTC