1234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890
-This should be truncated.
- -This line should never render in XML. -This is a test post.
-A whole bunch of other information.
-This blog post will test file name parsing issues when periods are present.
-This blog post will test file name parsing issues when periods are present.
-This is a test post.
-A whole bunch of other information.
-1234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890
-This should be truncated.
-After installing Docusaurus, you now have a skeleton to work from for your specific website. With a few changes, you can verify that Docusaurus was installed correctly by running the site locally.
-As shown after you installed Docusaurus, the initialization script created a directory structure similar to:
-root-of-repo
-├── docs-examples-from-docusaurus
-│ └── doc1.md
-│ └── doc2.md
-│ └── doc3.md
-│ └── exampledoc4.md
-│ └── exampledoc5.md
-└── website
-│ └── blog-examples-from-docusaurus
-│ └── 2016-03-11-blog-post.md
-│ └── 2017-04-10-blog-post-two.md
-│ └── core
-│ └── Footer.js
-│ └── node_modules
-│ └── package.json
-│ └── pages
-│ └── sidebars.json
-│ └── siteConfig.js
-│ └── static
-website/core/Footer.js file is a React component that acts as the footer for the site generated by Docusaurus and should be customized by the user.website/blog-examples-from-docusaurus folder contains examples of blog posts written in markdown.docs-examples-from-docusaurus folder contains example documentation files written in markdown.website/pages folder contains example top-level pages for the site.website/static folder contains static assets used by the example site.website/siteConfig.js file is the main configuration file used by Docusaurus.You will need to keep the website/siteConfig.js and website/core/Footer.js files, but may edit them as you wish.
You should keep the website/pages and website/static folders, but may change the content inside them as you wish. At the bare minimum you should have an en/index.js or en/index.html file inside website/pages and an image to use as your header icon inside website/static.
The website/blog-examples-from-docusaurus and docs-examples-from-docusaurus folders contain example blog and document markdown files. As shown below when you verify that the example site runs correctly, if you wish to run Docusaurus with these files, you need to rename the folders to website/blog and docs, respectively.
Running the Docusaurus initialization script, docusaurus-init, produces a runnable, example website to base your site upon.
docs-examples-from-docusaurus to docs.cd websiteblog-examples-from-docusaurus to blog.yarn run start or npm run start.
Powered by Markdown
-Save time and focus on your project's documentation. Simply -write docs and blog posts with Markdown -and Docusaurus will publish a set of static html files ready -to serve.
-
Built Using React
-Extend or customize -your project's layout by reusing React. Docusaurus can be -extended while reusing the same header and footer.
-
Ready for Translations
-Localization -comes pre-configured. Use Crowdin to translate your docs -into over 70 languages.
-
Document Versioning
-Support users on all versions of your project. Document -versioning -helps you keep documentation in sync with project releases.
-
Document Search
-Make it easy for your community to find what they need in your documentation. -We proudly support Algolia documentation search.
-Quick Setup
-Get up and running -quickly without having having to worry about site design.
-
Develop and Deploy
-Make design and documentation changes by using the included -live server. -Publish -your site to GitHub pages or other static file hosts -manually, using a script, or with continuous integration -like CircleCI.
-Website Features
-Docusaurus currently provides support to help your website -use translations, -search, -and versioning, -along with some other special documentation markdown features. -If you have ideas for useful features, feel free to -contribute on GitHub!
-
This project is used by many open source projects including...
Are you using this project?
Powered by Markdown
-Save time and focus on your project's documentation. Simply -write docs and blog posts with Markdown -and Docusaurus will publish a set of static html files ready -to serve.
-Built Using React
-Extend or customize -your project's layout by reusing React. Docusaurus can be -extended while reusing the same header and footer.
-Ready for Translations
-Localization -comes pre-configured. Use Crowdin to translate your docs -into over 70 languages.
-Document Versioning
-Support users on all versions of your project. Document -versioning -helps you keep documentation in sync with project releases.
-Document Search
-Make it easy for your community to find what they need in your documentation. -We proudly support Algolia documentation search.
-Quick Setup
-Get up and running -quickly without having having to worry about site design.
-Develop and Deploy
-Make design and documentation changes by using the included -live server. -Publish -your site to GitHub pages or other static file hosts -manually, using a script, or with continuous integration -like CircleCI.
-Website Features
-Docusaurus currently provides support to help your website -use translations, -search, -and versioning, -along with some other special documentation markdown features. -If you have ideas for useful features, feel free to -contribute on GitHub!
-This project is used by many open source projects including...
Are you using this project?