just-the-docs
diagrams
| just-the-docs | diagrams | |
|---|---|---|
| 17 | 110 | |
| 7,029 | 34,870 | |
| 2.8% | - | |
| 8.4 | 6.2 | |
| 6 days ago | 15 days ago | |
| SCSS | Python | |
| 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
-
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.
diagrams
- Diagrams as Code
-
Mastering Matplotlib: A Step-by-Step Tutorial for Beginners
diagrams - Diagram as Code.
- How to draw beautiful software architecture diagrams
-
Top 9 Architecture diagram software for cloud infrastructure
Mingrammer is an intriguing tool for individuals who prefer coding diagrams rather than creating them through graphical interfaces. It operates using Python code and offers a relatively quick setup process. It is compatible with AWS, Azure, GCP, Alibaba, and Oracle. Notably, the project is open source and has garnered significant attention on GitHub with over 31K stars.
-
Pravljenje AWS strukturnog diagrama
Ja sam koristio ovo: https://diagrams.mingrammer.com/
-
Dynamically generate Cloud System Architecture diagram
That’s another option: https://diagrams.mingrammer.com Guessing with IaC done with Pulumi (Python) and this, it could pretty powerful and automatically generated.
- [Golang] Diagrammes comme code avec Go?
- Network diagram Tool
-
Top 7 diagrams as code tools for software architecture
Diagrams allow you to draw cloud system architectures using Python code.
-
Do you like to draw while explaining stuff?
I use excalidraw a lot for short conversations. If I have to go into major detail I use diagrams https://diagrams.mingrammer.com
What are some alternatives?
Read the Docs - The source code that powers readthedocs.org
c4-draw.io - Draw.io template/diagram containing C4 Model shapes. Drawio Diagrams.net
MkDocs - Project documentation with Markdown.
Graphviz - Simple Python interface for Graphviz
jekyll-theme-chirpy - A minimal, responsive, and feature-rich Jekyll theme for technical writing.
obsidian-excalidraw-plugin - A plugin to edit and view Excalidraw drawings in Obsidian
Docusaurus - Easy to maintain open source documentation websites.
pygraphviz - Python interface to Graphviz graph drawing package
jekyll-docker - ⛴ Docker images, and CI builders for Jekyll.
excalidraw - Virtual whiteboard for sketching hand-drawn like diagrams
jekyll-theme-hamilton - A minimal and beautiful Jekyll theme best for writing and note-taking.
vscode-drawio - This unofficial extension integrates Draw.io (also known as diagrams.net) into VS Code.