just-the-docs
VuePress
Our great sponsors
just-the-docs | VuePress | |
---|---|---|
17 | 44 | |
6,981 | 22,306 | |
2.2% | 0.3% | |
8.4 | 4.1 | |
9 days ago | 13 days ago | |
SCSS | JavaScript | |
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?
VuePress
-
Free project idea - documentation framework!
VuePress - when I searched if it's supporting what I want (conditional rendering), the first result is a bug issue opened 4 years ago, so it doesn't seem to be a good option.
-
Using links in markdown to navigate files through directories.
I'm new to IA Writer, and I'm wanting to use it to draft posts for my Vuepress site.
-
Create a Static Site using VitePress for Beautiful Help Documentation
VitePress is listed in the documents as VuePress' little brother, and it is built on top of Vite. For those that don't know Vite is a build tool that aims to provide a faster and leaner development experience for modern web projects so it might sense to pair it with a static site generator such as VitePress. One of the original problems with VuePress was that it was a Webpack app and it took a lot of time to spin up a dev server for just a simple doc. VitePress solves these problems with nearly instant server start, an on-demand compilation that only compiles the page being served, and lightning-fast HMR. Let's get started!
-
10+ Must Use Static Site Generator 2022
VuePress
-
Do you use Vue for smaller static sites?
Definitely check out Vuepress for smaller static sites. We use it to publish our tutorials
-
Getting Tailwind to Work with Elm Book
Trying to help build a design system at work in my spare time; no clue if it will go anywhere but it’s fun regardless. I asked the Elm Slack group what the equivalent of React Storybook. Specifically, I wanted a way to build a documentation website like Vuepress with the ability to host native Elm code to showcase components. They pointed me to Elm Book. While Elm Book has built-in theming capabilities, I needed CSS control over my components. While they support elm-css, I wanted the ability to use TailwindCSS. The Elm libraries haven’t kept up with Tailwind’s changes, which is fine; writing raw Tailwind CSS on Elm HTML functions is easy and co-located with the component you’re styling.
-
How to Collect Documentation Statistics in Vuepress
Vuepress is a minimalistic static site generator with a Vue-powered theming system and a default theme that has been optimized for writing technical documentation.
-
Vue 3 comp api autogenerated component docs
You can use auto-import or Vue-Press. You can reference my-project using the auto-import plugin
-
Easy Way to Integrate Algolia to VuePress Application
This parameter is default and there is a issue.
What are some alternatives?
Docusaurus - Easy to maintain open source documentation websites.
MkDocs - Project documentation with Markdown.
typedoc - Documentation generator for TypeScript projects.
docsify - 🃏 A magical documentation site generator.
Read the Docs - The source code that powers readthedocs.org
Next.js - The React Framework
ToolJet - Low-code platform for building business applications. Connect to databases, cloud storages, GraphQL, API endpoints, Airtable, Google sheets, OpenAI, etc and build apps using drag and drop application builder. Built using JavaScript/TypeScript. 🚀
laravel-snappy - Laravel Snappy PDF
nextra - Simple, powerful and flexible site generation framework with everything you love from Next.js.
Vue.js - This is the repo for Vue 2. For Vue 3, go to https://github.com/vuejs/core
Gatsby - The best React-based framework with performance, scalability and security built in.