README.md

Docs Editor

A Markdown editor for Docusaurus content using GitHub to commit any progress and allow contributers to create a pull request to the upstream repository without the need to know Markdown or GitHub.

WORK IN PROGRESS: This project is in early development so expect functionality to be broken!

Usage

Add this plugin to your project:

yarn add jlvandenhout/docusaurus-plugin-docs-editor

Then enable the plugin in your Docusaurus configuration:

module.exports = {
  ...
  plugins: [
    [
      '@jlvandenhout/docusaurus-plugin-docs-editor',
      {
        // The path to the docs section in your repository
        docsPath: 'example/docs',

        // GitHub OAuth Application settings
        github: {
          clientId: '[GITHUB_CLIENT_ID]',
          tokenUri: '[GITHUB_TOKEN_URI]'
        }
      }
    ]
  ]
};

Example

To run the example webpage, you will need to set up a GitHub OAuth App to let users authenticate themselves and a server that manages your Client Secret and allows users to swap their authentication code for an access token (for an easy setup, have a look at Gatekeeper).

Then navigate to the example directory, set the needed environment variables or edit the Docusaurus config file directly and start the development server:

cd example
GITHUB_CLIENT_ID=123456789 GITHUB_TOKEN_URI=https://example.com yarn start