Overview:
The Nuxt.js website and its documentation are being written using Docus. The documentation is currently in progress and will be open sourced in the near future. The website design materials are licensed under a Creative Commons Attribution-NoDerivatives 4.0 International License.
Features:
- Docus: The documentation is being written using Docus, a tool for creating documentation websites.
- VS Code Extension: It is recommended to install the Docus extension for Visual Studio Code to enhance the documentation writing experience.
- Development Server: A development server can be started on http://localhost:4000 to test the website locally and assist in documenting Nuxt.
- Content Generation: The pages of the website are generated from the content folder, making it easy to edit and contribute to the documentation.
Installation:
To install the Nuxt.js theme and start contributing to the documentation, follow these steps:
- Install Docus by running the following command:
npm install -g docus
- Clone the Nuxt.js website repository:
git clone https://github.com/nuxt/website-v2.git
- Change directory to the website repository:
cd website-v2
- Install the project dependencies:
npm install
- Start the development server on http://localhost:4000:
npm run dev
- You can now start editing the content files in the content folder to contribute to the Nuxt.js documentation.
Summary:
The Nuxt.js website and its documentation are being developed using Docus. The documentation is planned to be open sourced in the future. Installing the Docus extension for Visual Studio Code is recommended. The development server can be started to locally test the website. The pages of the website are generated from the content folder, allowing for easy editing and contribution to the documentation. The website design materials are licensed under a Creative Commons Attribution-NoDerivatives 4.0 International License.