DOCSEARCHbyAlgolia
Submit Docs

DocSite Documentation

website·Indexed 30 days ago

https://docs-site-demo.netlify.app

A documentation management platform designed to simplify the process of creating, organizing, and managing documentation. Features include i18n translation, version management, and a user-friendly interface for software development teams.

Tokens
2.2K
Snippets
18
Records
28
Agent score
73%

What's inside DocSite

  1. Introduction to DocSite documentation platform

    DocSite is a documentation management platform designed for creating, organizing, and sharing documentation. It provides tools for team collaboration, version control, and role-based access control to manage permissions and user roles. It supports customizable templates and integrates with popular tools and services to streamline documentation workflows for developers, project managers, and technical writers.

  2. Overview of DocSite documentation platform

    DocSite is a documentation platform that enables teams to create, manage, and share documentation. It features a user-friendly interface, collaboration tools, and version control to help teams maintain organization and productivity.

  3. Limit blog post summary length in list view

    To control the amount of content displayed for a blog post in the list view, insert a <!-- truncate --> HTML comment within the post content. Content appearing after this comment will be hidden in the list view and only visible on the full post page.
    This text will appear in the blog list summary.

<!-- truncate -->

This text will only appear on the full blog post page.

  4. Translate documentation files for a specific locale

    To translate a document, copy the original markdown file from the docs folder into the corresponding locale directory within the i18n folder. The directory structure must follow the plugin pattern: i18n/{locale}/docusaurus-plugin-content-docs/current/.
    # Example: Translating docs/intro.md to French (fr)
mkdir -p i18n/fr/docusaurus-plugin-content-docs/current/
cp docs/intro.md i18n/fr/docusaurus-plugin-content-docs/current/intro.md

  5. Install Docusaurus prerequisites

    To run Docusaurus, you must have Node.js version 18.0 or above installed. It is recommended to enable all dependency-related checkboxes during the Node.js installation process.

  6. Set blog post dates via filenames

    Docusaurus can automatically extract the blog post date from the filename. Use the format YYYY-MM-DD-title.md or place an index.md inside a folder named YYYY-MM-DD-title.
    2019-05-30-welcome.md
2019-05-30-welcome/index.md

  7. Create a new documentation version in Docusaurus

    Use the Docusaurus CLI to snapshot the current state of your docs folder into a versioned directory. This creates a permanent copy of the documentation for a specific release. When a version is created, the docs folder is copied to versioned_docs/version-{versionName} and a versions.json file is generated to track the versions.
    npm run docusaurus docs:version 1.0

  8. Update content for specific documentation versions

    Docusaurus separates content by version using different directories. To update a specific version, edit the file within its corresponding folder in versioned_docs. To update the upcoming (unreleased) version, edit the files in the main docs folder.

    • Versioned content: Edit files in versioned_docs/version-1.0/ to update the 1.0 release.
    • Current/Next content: Edit files in docs/ to update the unreleased documentation (typically served at /docs/next/).

  9. Create interactive Docusaurus blog posts using MDX

    Docusaurus blog posts support MDX, allowing you to embed interactive React components directly within your markdown content. This enables the creation of dynamic elements, such as buttons or custom widgets, inside blog articles.
    <button onClick={() => alert('button clicked!')}>Click me!</button>

  10. Create and manage blog posts in Docusaurus

    Docusaurus blogging features are powered by the @docusaurus/plugin-content-blog plugin. To create blog posts, add Markdown files or folders to the blog directory. To manage recurring authors, use the authors.yml file. Blog post dates are automatically extracted from filenames using the format YYYY-MM-DD-title.md or by placing an index.md inside a folder named YYYY-MM-DD-title.
    # Example filename for date extraction
2019-05-30-welcome.md

# Example folder structure for co-locating images
blog/2019-05-30-welcome/index.md
blog/2019-05-30-welcome/image.jpg

  11. Get started with DocSite

    To begin using DocSite, sign up for an account. Once registered, you can create documentation, invite team members for collaboration, and customize documentation templates.

  12. Create and organize blog posts in Docusaurus

    Docusaurus blogging features are powered by the @docusaurus/plugin-content-blog plugin. To create blog posts, add Markdown files or folders to the blog directory.

    Blog post dates are automatically extracted from filenames using the format YYYY-MM-DD-title.md (e.g., 2019-05-30-welcome.md) or from an index.md file within a dated folder (e.g., 2019-05-30-welcome/index.md). Using a folder for a post is recommended for co-locating images with the content.