Skip to main content

· One min read
Hamel Husain

Never copy and paste code into documentation again!

Background

This project enables you to create blog posts and/or documentation with Docusaurus using Jupyter Notebooks. When you create documentation with notebooks:

  • Your documentation is fully testable with unit tests
  • No more copy / pasting code into your blog posts and docs
  • The output of code is always up to date, since it is generated by actually running code, rather than copying and pasting it from somewhere else.
  • You can author technical posts and docs in a WYSIWYG manner, which allows you to iterate faster.
  • You can still write markdown posts if you want to.

Blog posts support Docusaurus Markdown features, such as MDX.

To get started go here.

The rest of these blog posts are reference blog posts from the Docusarus documentation.

· One min read
Sébastien Lorber
Yangshun Tay

Docusaurus blogging features are powered by the blog plugin.

Simply add Markdown files (or folders) to the blog directory.

Regular blog authors can be added to authors.yml.

The blog post date can be extracted from filenames, such as:

  • 2019-05-30-welcome.md
  • 2019-05-30-welcome/index.md

A blog post folder can be convenient to co-locate blog post images:

Docusaurus Plushie

The blog supports tags as well!

And if you don't want a blog: just delete this directory, and use blog: false in your Docusaurus config.

· One min read
Gao Wei

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet