Spacebar/docs
1
0
Fork 0
mirror of https://github.com/spacebarchat/docs.git synced 2024-11-08 11:22:31 +01:00
Code Issues Releases Activity
Mirror of https://github.com/spacebarchat/docs
349 Commits 6 Branches 0 Tags 11 MiB
Text 100%
f43c66b1b3
Go to file
Catalan Lover f43c66b1b3
Merge pull request #63 from bitfl0wer/main 
Fix "github.com//repo_name"
2023-03-30 18:37:14 +02:00
.github Push Major Rebrand 2023-03-30 08:13:55 -06:00
.vscode Push Major Rebrand 2023-03-30 08:13:55 -06:00
docs Add DB_LOGGING env 2023-03-30 18:13:04 +02:00
.gitignore Add venv/ to .gitignore 2023-03-18 11:49:44 +01:00
.prettierrc prettier 2023-01-02 20:13:12 +11:00
LICENSE Update LICENSE 2021-05-14 15:01:32 +02:00
mkdocs.yml Fix "github.com//repo_name" 2023-03-30 18:33:23 +02:00
package.json add package.json 2023-01-15 18:54:57 -05:00
README.md Push Major Rebrand 2023-03-30 08:13:55 -06:00
requirements.txt Add mkdocs-macros-plugin dependency 2023-03-19 12:21:42 +01:00

README.md

Spacebar Docs

Build to GitHub Pages code style: prettier

Deploy with Vercel

How to get started

  1. Fork this repository.

  2. Clone the forked repository.

    git clone https://github.com/<YOUR_USERNAME_HERE>/docs

  3. Install dependencies.

    python3 -m pip install mkdocs-material mkdocs-swagger-ui-tag mkdocs-section-index mkdocs-macros-plugin

  4. Edit documents(s).

    • Format document(s).

    Spacebar uses prettier formatter to consistently format our documents. Instructions to install and use prettier can be found here.

    If you are using vscode, install the prettier extension to automatically format documents on save.

  5. Test locally.

    • Serve in http://127.0.0.1:8000 with hot reload:

      python3 -m mkdocs serve

    • Build for production:

      python3 -m mkdocs build

  6. Commit changes with good commit messages.

  7. Create a pull request.