Spacebar/docs
1
0
Fork 0
mirror of https://github.com/spacebarchat/docs.git synced 2024-11-25 03:33:05 +01:00
Code Issues Releases Activity

Removed badge from headers and replaced inline code to code blocks

Browse Source 
Makes link prettier and easier to copy commands (github creaates a copy button when using code blocks)
This commit is contained in:
developomp 2021-10-14 19:45:24 +09:00
parent 26789618c7
commit c57ec25b8a
1 changed files with 23 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
README.md
View File

@ -1,12 +1,31 @@
# Fosscord Docs [![Build to GitHub Pages](https://github.com/fosscord/fosscord-docs/actions/workflows/build.yml/badge.svg)](https://github.com/fosscord/fosscord-docs/actions/workflows/build.yml)
# Fosscord Docs
[![Build to GitHub Pages](https://github.com/fosscord/fosscord-docs/actions/workflows/build.yml/badge.svg)](https://github.com/fosscord/fosscord-docs/actions/workflows/build.yml)
## How to get started:
`git clone https://github.com/fosscord/fosscord-docs && python3 -m pip install mkdocs-material mkdocs-section-index`
1. Clone the docs repository
```bash
git clone https://github.com/fosscord/fosscord-docs
```
2. Install
```bash
python3 -m pip install mkdocs-material mkdocs-section-index
```
3. Test locally
- development:
`python3 -m mkdocs serve`
```bash
python3 -m mkdocs serve
```
- production:
`python3 -m mkdocs build`
```bash
python3 -m mkdocs build
```