reverie
just-the-docs
reverie | just-the-docs | |
---|---|---|
4 | 17 | |
767 | 7,044 | |
- | 1.6% | |
3.1 | 8.4 | |
22 days ago | about 1 hour 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.
reverie
-
Just deployed a simple and boring little website to solve my own inconvenience!
I've customized this theme to suit my taste: https://github.com/amitmerchant1990/reverie
-
Best place to document learnings
If you like writing in markdown, you can use GitHub Pages for free and it's easy to put it under your own domain or later rehost on another server. There are a bunch of templates. I use reverie.
-
Cost to Create a Site
If you dont want to spend too much and its just a blog you need maybe you can find one of those "create a blog sites" that would suit you best and host it on your own domain. Like this one: https://www.blogger.com/, I personally use https://github.com/amitmerchant1990/reverie but its a bit technical to set it up and write articles for it.
-
Unreal Engine : The basics for a programmer to understand the engine
You can do it pretty easy on github pages! I think it was as easy as forking a template, changing _config.yml, replacing their _posts with your reddit post's markdown, and adding a header to your markdown (for tags, page title).
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
-
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.
-
Looking for advice: does any one use GitHub/GitClassroom to store and mange their course content?
So the basic idea is I use the Jekyll site generator (which is already built into GitHub pages, but you can also install locally), and this is the theme I use: https://just-the-docs.github.io/just-the-docs/
- 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.
-
Compiling findings to website
The pages are written in markdown and the site has an in-built search feature. I am using the https://github.com/just-the-docs/just-the-docs jekyll theme.
-
Atlassian Patch Critical Confluence Hardcoded Credentials Bug
The only people that like confluence have Stockholm syndrome. I'd argue that a wiki is the old people way of thinking. In most orgs a wiki is where data goes to die but some asshole keeps throwing data in there to appease some other asshole. I rather search slack, https://github.com/just-the-docs/just-the-docs, project boards in github, anything is better than confluence and I couldn't agree more that confluence search is the biggest piece of shit ever, it's worse than useless, it wastes your time.
-
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.
What are some alternatives?
Saga - A Ghost theme designed for photostories :sunrise_over_mountains:
Read the Docs - The source code that powers readthedocs.org
rTS_Wiki - The official r/TS wiki repository. Contributions welcome.
MkDocs - Project documentation with Markdown.
millidocs - A simple documentation theme for Jekyll.
jekyll-theme-chirpy - A minimal, responsive, and feature-rich Jekyll theme for technical writing.
Dark-Particle - Website-Boilerplate | Combo of Webpack, Bootstrap... to develop/build a cross-browser & -device, dark-theme blog + portfolio website with exchangeable WebGL header - Demo:
Docusaurus - Easy to maintain open source documentation websites.
minimal - Minimal is a Jekyll theme for GitHub Pages
jekyll-docker - ⛴ Docker images, and CI builders for Jekyll.
Type-on-Strap - 🎨 Simplistic, responsive jekyll based open source theme
jekyll-theme-hamilton - A minimal and beautiful Jekyll theme best for writing and note-taking.