crossroad
just-the-docs
crossroad | just-the-docs | |
---|---|---|
5 | 17 | |
31 | 7,044 | |
- | 1.6% | |
0.0 | 8.4 | |
over 1 year ago | about 21 hours ago | |
JavaScript | 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.
crossroad
-
What are your favorite, must-have packages when you're creating a project?
https://crossroad.page/ (1.74kb) routing, similar to React Router
-
React Router 6.4 Release
Seeing the direction React Router was taking (even before they started mixing things with data loading/management), I wrote a small alternative https://crossroad.page/ that only does routing but does it following modern React best practices:
-
Show HN: React Routing in 120 lines (including comments)
1kb is likely a lot more than what is shown here; I made a "tiny" but very complete React Router package which is very complete and minified+gzip it's just 1.8kb https://crossroad.page/
-
Not Another Framework
The author claims to "learn JS/HTML", but the first example is importing a custom component called Link with who knows what inside, which I find especially ironic because I made a small library[1] for routing in React where links are just links:
Login
[1] https://crossroad.page/
-
Ask HN: What are you using for public documentation these days?
I have an unfinished side project called Documentation Page:
https://documentation.page/
It's "unfinished" because I'd need to integrate payments and do all the accounting on my side (non-trivial as an individual living in Japan), but otherwise it's worked pretty well for my own projects.
It parses your Github Repo (according to https://documentation.page/documentation#getting-started) to generate the website. It can be a single readme.md file (for smaller projects), a folder called "documentation", or you can configure it otherwise. Some examples hosted by Documentation Page:
- statux.dev: simple single-page docs and website, menu config in https://github.com/franciscop/statux/blob/master/documentati.... Similar to form-mate.dev & vector-graph.com
- react-test.dev: split into multiple pages, you specify the folder and it'll automatically merge the markdown files. See config https://github.com/franciscop/react-test/blob/master/documen...
- crossroad.page: has an landing page, but that is not officially supported (yet). See the configs in https://github.com/franciscop/crossroad/blob/master/document...
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?
hookrouter - The flexible, and fast router for react that is entirely based on hooks
Read the Docs - The source code that powers readthedocs.org
universal-router - Universal routing both for backend and frontend
MkDocs - Project documentation with Markdown.
manconvert - Convert troff-style man pages to doxygen source or formatted HTML
jekyll-theme-chirpy - A minimal, responsive, and feature-rich Jekyll theme for technical writing.
typesense-docsearch-scraper - A fork of Algolia's awesome DocSearch Scraper, customized to index data in Typesense (an open source alternative to Algolia)
Docusaurus - Easy to maintain open source documentation websites.
one-app-router - ✨Declarative routing for One App forked from React Router 3
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.