Skip to content

☁️ Welcome to Web Space Docs

This is the official documentation for Web Space. Here you will find comprehensive guides and documentation to help you start working with Web Space as quickly as possible.

🤔 How to Update Information

To update information or contribute to these docs:

  1. Visit the Web Space Docs GitHub repository.
  2. Fork the repository to your own GitHub account.
  3. Make your changes in your forked repository.
  4. Create a Pull Request (PR) from your forked repository to the original web-space-dev/docs repository.

Your PR will be reviewed and, if approved, the changes will be merged into the main documentation.

🏗️ Project Layout

mkdocs.yml    # The configuration file.
docs/
    index.md  # The documentation homepage.
    ...       # Other markdown pages, images and other files.

🔧 Installation

To run this locally, you need to have Python installed, and the mkdocs package. You can install mkdocs using pip:

pip install mkdocs

You also need to have the mkdocs-material theme installed. You can install it using pip:

pip install mkdocs-material

💻 Commands

  • mkdocs new [dir-name] - Create a new project.
  • mkdocs serve - Start the live-reloading docs server.
  • mkdocs build - Build the documentation site.
  • mkdocs -h - Print help message and exit.