n8n-docs VS Docusaurus

n8n (27.2k)

n8n documentation

Focus on Documentation We get more traffic to our documentation than our main website. A well-documented project is always loved by the community. Open-source projects like Docusaurus make it super easy to build documentation portals that look great just out of the box. Adding links to the repository from the documentation can drive more visitors to your repository. What to include in documentation How to install/deploy the project If the project has a compiled software as the final product, make sure to add installation instructions. If the project is the codebase for a library such as an npm package or a Ruby gem, include details on how to import and use the library. If the project needs to be or can be deployed on platforms like Kubernetes, Docker, Heroku, and others, include separate guides for each of the options. Contributing guide Apart from the contributing guide doc in the codebase, add one to the documentation, too. It should include guides for setting up a local environment on different platforms like Docker, Mac OS, Ubuntu, Windows, and so on. Tutorials and code examples If this is applicable, it can be really helpful. How to guides on using using the project will show other devs how they can actually get started. It can be code examples if the project is a library. Architecture reference It will be helpful for the contributors if the documentation has details on different components of the project. For example, if the project has server and client components, include a diagram on how everything works together. Here are some projects with great documentation: https://docs.nestjs.com/ https://docs.n8n.io/ https://guides.rubyonrails.org/ https://plotly.com/python/ https://docs.mapbox.com/ https://www.github-stars.com or Github24.

Here are some projects with great documentation: a) https://docs.nestjs.com/ b) https://docs.n8n.io/ c) https://guides.rubyonrails.org/ d) https://plotly.com/python/ e) https://docs.mapbox.com/

Contribute to n8n: You can work on open issues, create nodes, improve our docs, or write a blog post.

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.

// @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;

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...

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.

Wondering why Docusaurus (https://docusaurus.io) did not match their needs. Works perfectly fine as a blogging engine for our tech blog.

This is developed by Meta. You can create really nice-looking documentation websites super fast.

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

Fix "Edit this page" links at the bottom of each doc (Problem with the Docusaurus build I guess)