3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-04-28 17:57:48 +02:00
Code Issues Projects Releases Packages Wiki Activity
Easy to maintain open source documentation websites.
1885 commits 47 branches 176 tags 867 MiB
TypeScript 88.3%
HTML 5.9%
JavaScript 2.8%
CSS 2%
XSLT 0.8%
Find a file
Pawel Kadluczka c23f981f67 refactor(v2): Convert sitemap plugin to TypeScript (#1894) 
* Convert sitemap plugin to TypeScript

Test - enabled the sitemap plugin in the v2 website and verified that
the sitemap is created after running `docusaurus build`.

* Addressing review comments
2019-10-27 14:44:53 +07:00
.circleci chore: download only enabled languages translation files 2019-07-26 23:07:04 +07:00
.github misc: facebook/Docusaurus -> facebook/docusaurus 2019-10-12 01:11:34 -07:00
admin misc: facebook/Docusaurus -> facebook/docusaurus 2019-10-12 01:11:34 -07:00
docs docs(v1): document how to include Google Fonts (#1852) 2019-10-20 12:22:35 -07:00
packages refactor(v2): Convert sitemap plugin to TypeScript (#1894) 2019-10-27 14:44:53 +07:00
scripts chore: fix conflicting yarn 'version' 2019-04-10 22:01:37 +08:00
website docs(v2): update plugins, presets and themes docs (#1889) 2019-10-26 15:10:48 +07:00
website-1.x v2.0.0-alpha.31 2019-10-26 14:12:15 +07:00
.editorconfig Standardize editor configs for cross-platform development (#628) 2018-05-03 10:23:21 -07:00
.eslintignore refactor(v2): Convert sitemap plugin to TypeScript (#1894) 2019-10-27 14:44:53 +07:00
.eslintrc.js chore(v2): tweak eslint config (#1445) 2019-05-09 20:01:48 +07:00
.gitattributes Add .webp to .gitattributes for ignoring 2018-05-03 13:13:03 -07:00
.gitignore refactor(v2): Convert sitemap plugin to TypeScript (#1894) 2019-10-27 14:44:53 +07:00
.prettierignore refactor(v2): Convert sitemap plugin to TypeScript (#1894) 2019-10-27 14:44:53 +07:00
.prettierrc refactor(v2): migrate core to Typescript ❄️🌀🐋 (#1494) 2019-05-20 09:59:04 -07:00
.watchmanconfig Add first set of docusaurus-build tests using Jest (#259) 2017-12-18 14:40:52 -08:00
babel.config.js refactor(v2): migrate to Typescript ❄️🌀🐋 (#1490) 2019-05-18 11:37:35 -07:00
CHANGELOG-2.x.md refactor(v2): Convert sitemap plugin to TypeScript (#1894) 2019-10-27 14:44:53 +07:00
CHANGELOG.md misc: fix typo in CHANGELOG 2019-10-20 12:45:42 -07:00
CODE_OF_CONDUCT.md Update CODE_OF_CONDUCT.md 2018-07-31 19:49:46 -07:00
CONTRIBUTING.md misc: facebook/Docusaurus -> facebook/docusaurus 2019-10-12 01:11:34 -07:00
crowdin.yaml chore: download only enabled languages translation files 2019-07-26 23:07:04 +07:00
jest.config.js refactor(v2): add typing for pages plugin (#1813) 2019-10-07 22:35:58 -07:00
lerna.json v2.0.0-alpha.31 2019-10-26 14:12:15 +07:00
LICENSE The complete move to MIT license (#115) 2017-10-05 11:14:49 -07:00
LICENSE-docs Docusaurus documentation license (#118) 2017-10-06 12:59:01 -07:00
package.json chore(v2): upgrade dependencies (#1865) 2019-10-21 12:25:30 +07:00
README.md misc: facebook/Docusaurus -> facebook/docusaurus 2019-10-12 01:11:34 -07:00
tsconfig.json refactor(v2): migrate core to Typescript ❄️🌀🐋 (#1494) 2019-05-20 09:59:04 -07:00
yarn.lock styles(v2): update infima and fix styles (#1892) 2019-10-25 22:06:06 -07:00

README.md

Docusaurus

Docusaurus

npm version CircleCI status PRs Welcome Chat code style: prettier Tested with Jest Netlify Status

Introduction

Docusaurus is a project for easily building, deploying, and maintaining open source project websites.

  • Simple to Start Docusaurus is built to be easy to get up and running in as little time possible. We've built Docusaurus to handle the website build process so you can focus on your project.
  • Localizable Docusaurus ships with localization support via CrowdIn. Empower and grow your international community by translating your documentation.
  • Customizable While Docusaurus ships with the key pages and sections you need to get started, including a home page, a docs section, a blog, and additional support pages, it is also customizable as well to ensure you have a site that is uniquely yours.

Installation

Docusaurus is available as the docusaurus package on npm.

We have also released the docusaurus-init package to make getting started with Docusaurus even easier.

Contributing

We've released Docusaurus because it helps us better scale and supports the many OSS projects at Facebook. We hope that other organizations can benefit from the project. We are thankful for any contributions from the community.

Code of Conduct

Facebook has adopted a Code of Conduct that we expect project participants to adhere to. Please read the full text so that you can understand what actions will and will not be tolerated.

Contributing Guide

Read our contributing guide to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to Docusaurus.

Beginner Friendly Bugs

To help you get your feet wet and get you familiar with our contribution process, we have a list of beginner friendly bugs that contain bugs which are fairly easy to fix. This is a great place to get started.

Contact

We have a few channels for contact:

  • Discord with two text channels:
    • #docusaurus-users for those using Docusaurus.
    • #docusaurus-dev for those wanting to contribute to the Docusaurus core.
  • @docusaurus on Twitter
  • GitHub Issues

Contributors

This project exists thanks to all the people who contribute. [Contribute].

Backers

Thank you to all our backers! 🙏 [Become a backer]

Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]

License

Docusaurus is MIT licensed.

The Docusaurus documentation (e.g., .md files in the /docs folder) is Creative Commons licensed.