documentation
Docusaurus
documentation | Docusaurus | |
---|---|---|
6 | 282 | |
942 | 53,209 | |
3.6% | 1.5% | |
9.7 | 9.5 | |
3 days ago | about 6 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.
documentation
-
Sanity vs Prismic vs Contentful vs Storyblok - Which API-Driven Hosted CMS for Content-Focussed Sites?
Suitability for content-first sites (marketing/personal/portfolio sites) Components and Dynamic Zones will be very helpful to allow content editors to build pages on the fly by reusing components you, as a developer, will configure (based on your Astro components) for them. Was the free plan adequate or did you find yourself nearing limits or having to go for paid plans? Free if you self-host but paid if you use Strapi Cloud. I understand you want to use a free plan but do make sure you anticipate the limits of free plans (which you might quickly reach) as the gap from free to paid can be high for some solutions. General developer experience and time/simplicity to set up Strapi has been created by developers for developers. You should easily get started https://docs.strapi.io/ :) User experience as a content manager using the CMS to make changes to the sit As mentioned above, Components and Dynamic Zones will help a lot. Content managers will enjoy other features such as role-based access control, content internationalization, custom fields, media library, etc.
-
A Guide to Technical Writing
With practice comes perfection. The only way to be a great technical writer is to write more. The more you write, the more you learn and get better. Once you are comfortable writing for the Write For the Community program at Strapi, you may also venture into contributing to making our documentation better.
-
Hacktoberfest 2022: 7 Open Source Projects to Contribute to
Strapi’s core issues and documentation issues.
-
Strapi v4 Heroku
Fortunately this managed to get solved here https://github.com/strapi/documentation/issues/849
-
Why use Next.js + Strapi?
Strapi Documentation Next.js documentation 10 Reasons you should use a Headless CMS
-
Amplication – Instantly Generate Node.js Apps with GraphQL and REST API
How is this different than something like Strapi?
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?
vuepress-plugin-plausible - VuePress plugin for Plausible.io
nextra - Simple, powerful and flexible site generation framework with everything you love from Next.js.
amplication - 🔥🔥🔥 Open-source backend development platform. Build production-ready services without wasting time on repetitive coding.
storybook - Storybook is a frontend workshop for building UI components and pages in isolation. Made for UI development, testing, and documentation.
react-ssr - A baseline for server side rendering for your React application
oauth2-proxy - A reverse proxy that provides authentication with Google, Azure, OpenID Connect and many more identity providers.
razzle - ✨ Create server-rendered universal JavaScript applications with no configuration
JSDoc - An API documentation generator for JavaScript.
strapi-docker - Install and run your first Strapi project using Docker
VuePress - 📝 Minimalistic Vue-powered static site generator
do-strapi - Strapi on DigitalOcean App Platform
MkDocs - Project documentation with Markdown.