https://github.com/ioncakephper/yaml-to-docusaurus

NodeJS app to create Markdown documents and sidebar for Docusaurus from a .yaml outline file.
https://github.com/ioncakephper/yaml-to-docusaurus

Last synced: 3 months ago
JSON representation

NodeJS app to create Markdown documents and sidebar for Docusaurus from a .yaml outline file.

• Host: GitHub
• URL: https://github.com/ioncakephper/yaml-to-docusaurus
• Owner: ioncakephper
• License: mit
• Created: 2020-01-01T12:41:54.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-12-10T11:38:48.000Z (7 months ago)
• Last Synced: 2025-01-21T23:33:27.923Z (5 months ago)
• Language: JavaScript
• Size: 1.41 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# yaml-to-docusaurus

NodeJS app to create Markdown documents and sidebar for Docusaurus from a .yaml outline file.

## Installation

Install `yaml-to-docusaurus` globally:

```bash

$ npm install yaml-to-docusaurus -g

```

## Initialize `yaml-to-docusaurus`

Change to the folder storing the `docusaurus` environment, and run `yaml-to-docusaurus-init`.

```bash

$ cd 

$ yaml-to-docusaurus-init

```

The `templates` folder, `yaml-to-docusaurus.yaml` file, and `yaml-to-docusaurus-config.js` file appear in the folder.

## Add topics and headers to `yaml-to-docusaurus.yaml`

You can update the project title, add or edit topic titles and headers. Edit `yaml-to-docusaurus.yaml` and make sure the `.yaml` file is valid.

## Generate