retype
Docusaurus
Our great sponsors
retype | Docusaurus | |
---|---|---|
20 | 282 | |
972 | 52,824 | |
4.5% | 2.0% | |
8.7 | 9.5 | |
15 days ago | about 21 hours ago | |
JavaScript | TypeScript | |
GNU General Public License v3.0 or later | 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.
retype
- MdBook – Create book from Markdown files. Like Gitbook but implemented in Rust
-
How to turn a folder of markdown docs into a structured docs section in an app?
Outside of Swift, I use RetypeApp and they have a lot of inbuilt functionality. You can then generate your output directory on build, and use those HTML files as is.
- Où heberger son site web ?
-
Pushing for quality UX as an influence role
You can build pretty beautiful docs with: - https://retype.com - https://docusaurus.io - https://www.intercom.com/articles
-
GitLab Wiki or Other self-hosted wiki for Documentation
Retype is the nicest one I’ve come across in my search! Has a built in table of contents, pretty easy to create (entirely using markdown) and great support for emojis, math, containers, multi tab info panels, and proper dropdown panels.
-
Help setting up GitHub site
Are you aiming at creating something like this? With a bar on the left with folders?
- Where/ how you store and distribute documentation?
-
Is there an easy to use selfhosted wiki?
I recently set up something with https://retype.com/ and it's quite good.
-
Retype: A self-hosted and free alternative to gitbook
While gitbook does wrap the branching/merging process in a UI that is digestible by non-developers, Retype is far more powerful because you actually use GitHub (or GitLab). You have the full power of GitHub, including branching, pull-requests, issues, reviews, automation, authentication, and everything else.
For example, here's the repo for the retype.com website, see https://github.com/retypeapp/retype
The entire website is built from simple Markdown text files.
Docusaurus
-
Alternatives to Docusaurus for product documentation
Docusaurus is a popular open-source documentation tool primarily designed for product documentation and other technical documentation needs. It was first released in 2017 by Facebook Open Source (now Meta Open Source). Just recently, Docsaurus version 3.0 was released.
-
Docusaurus doesn't recognize brackets {} on the markdown files
// @ts-check // `@type` JSDoc annotations allow editor autocompletion and type checking // (when paired with `@ts-check`). // There are various equivalent ways to declare your Docusaurus config. // See: https://docusaurus.io/docs/api/docusaurus-config import { themes as prismThemes } from "prism-react-renderer"; /** @type {import('@docusaurus/types').Config} */ const config = { title: "My Site", tagline: "Dinosaurs are cool", url: "https://your-docusaurus-test-site.com", baseUrl: "/", onBrokenLinks: "throw", onBrokenMarkdownLinks: "warn", favicon: "img/favicon.ico", organizationName: "facebook", // Usually your GitHub org/user name. projectName: "docusaurus", // Usually your repo name. presets: [ [ "docusaurus-preset-openapi", /** @type {import('docusaurus-preset-openapi').Options} */ ({ docs: { sidebarPath: require.resolve("./sidebars.js"), // Please change this to your repo. editUrl: "https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/", }, blog: { showReadingTime: true, // Please change this to your repo. editUrl: "https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/", }, theme: { customCss: require.resolve("./src/css/custom.css"), }, }), ], ], themeConfig: /** @type {import('docusaurus-preset-openapi').ThemeConfig} */ ({ navbar: { title: "My Site", logo: { alt: "My Site Logo", src: "img/logo.svg", }, items: [ { type: "doc", docId: "intro", position: "left", label: "Tutorial", }, { to: "/api", label: "API", position: "left" }, { to: "/blog", label: "Blog", position: "left" }, { href: "https://github.com/facebook/docusaurus", label: "GitHub", position: "right", }, ], }, footer: { style: "dark", links: [ { title: "Docs", items: [ { label: "Tutorial", to: "/docs/intro", }, ], }, { title: "Community", items: [ { label: "Stack Overflow", href: "https://stackoverflow.com/questions/tagged/docusaurus", }, { label: "Discord", href: "https://discordapp.com/invite/docusaurus", }, { label: "Twitter", href: "https://twitter.com/docusaurus", }, ], }, { title: "More", items: [ { label: "Blog", to: "/blog", }, { label: "GitHub", href: "https://github.com/facebook/docusaurus", }, ], }, ], copyright: `Copyright © ${new Date().getFullYear()} My Project, Inc. Built with Docusaurus.`, }, prism: { theme: prismThemes.github, darkTheme: prismThemes.dracula, }, }), }; export default config;
- Looking for open source documentation generator
-
Show HN: A Python-based static site generator using Jinja templates
Facebook's React/Markdown SSG docusaurus does those things: https://docusaurus.io/
Though you may have to use a plugin for responsive images: https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-id...
- Craft Your GitHub Profile Page in 60 Seconds with Zero Code, Absolutely Free
-
Top 5 Open-Source Documentation Development Platforms of 2024
Docusaurus is an open-source static site generator built on React and has emerged as a popular tool for developing and maintaining product documentation. Its ease of use, extensive features, and robust community support make it a compelling choice for many organizations.
-
No CMS? Writing Our Blog in React
Wondering why Docusaurus (https://docusaurus.io) did not match their needs. Works perfectly fine as a blogging engine for our tech blog.
-
Best Software Documentation Tools
This is developed by Meta. You can create really nice-looking documentation websites super fast.
-
Can Git or any other VCS be used as a database instead of SQL/NoSQL ones? Have you ever seen such a thing?
Docusaurus, a documentation tool by Facebook, hosts a showcase of other websites that use Docusaurus on their Homepage. The list of websites of this showcase is a typescript files that is maintained by Docusaurus devs, and that you can add your website to through PR: https://github.com/facebook/docusaurus/blob/main/website/src/data/users.tsx
-
Community project: PreventRansomware.io
Fix "Edit this page" links at the bottom of each doc (Problem with the Docusaurus build I guess)
What are some alternatives?
Wiki.js - Wiki.js | A modern and powerful wiki app built on Node.js
nextra - Simple, powerful and flexible site generation framework with everything you love from Next.js.
mkdocs-material - Documentation that simply works
storybook - Storybook is a frontend workshop for building UI components and pages in isolation. Made for UI development, testing, and documentation.
docs - Auth0 documentation
oauth2-proxy - A reverse proxy that provides authentication with Google, Azure, OpenID Connect and many more identity providers.
BookStack - A platform to create documentation/wiki content built with PHP & Laravel
JSDoc - An API documentation generator for JavaScript.
wiki - The official Wiki of the selfhosted.show Podcast.
VuePress - 📝 Minimalistic Vue-powered static site generator
PeakRDL-html - Generate address space documentation HTML from compiled SystemRDL input
MkDocs - Project documentation with Markdown.