Skip to content

Latest commit

 

History

History
65 lines (38 loc) · 2.75 KB

README.md

File metadata and controls

65 lines (38 loc) · 2.75 KB
Raw

learn-docusaurus

The learn-docusaurus repository is dedicated to learning and exploring Docusaurus, an open-source project for building, deploying, and maintaining documentation websites. This repository serves as a collection of projects built using Docusaurus, showcasing various use cases and examples that can be helpful for anyone looking to learn or improve their skills in using this powerful documentation framework.

About Docusaurus

Docusaurus is a powerful documentation framework that makes it easy to maintain and deploy documentation websites.

Repository Structure

Each project in this repository is a standalone example of a specific use case or feature of Docusaurus. These projects are designed to provide practical insights and hands-on experience with different aspects of Docusaurus.

Featured Projects

  • my-docs-website: An introductory docs-only project to help you get started with Docusaurus Docs-only mode.

Upcoming Projects

These projects are currently in development and will be available soon:

  • theme-customization: Demonstrates how to customize the look and feel of a Docusaurus site.
  • versioning-docs: An example of handling documentation versioning with Docusaurus.

Getting Started

To get started with Docusaurus learning journey, follow these steps:

  • Clone repository

    git clone https://github.com/jnikhila/learn-docusaurus.git

  • Go to the desired project directory. For example, my-docs-website

    cd learn-docusaurus/my-docs-website

  • Install dependencies

    npm install

  • Start the development server

    npm start

    This command runs the development server and opens up your browser to the my-docs-website site.

Contributing

Contributions to this repository are welcome! Whether you're interested in adding your own Docusaurus project, improving existing examples, or providing feedback, your input is valuable.

Future Projects and Community Requests

We have more projects on the way! If you have specific use cases or features in Docusaurus you'd like to see explored, feel free to start a conversation. Your suggestions and requests are welcome, as they can help shape future examples and contribute to this learning resource. To propose an idea or request a new example, please open an issue in this repository.

If you have a Docusaurus project or an example that you believe would be beneficial to others, please feel free to fork this repository, add your project, and submit a pull request.

License

This repository is licensed under the BSD 3-Clause License. For more details, see the LICENSE file in the repository.