AkkomaGang
/
docs
Archived
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update readme, make code blocks more readable
ci/woodpecker/push/release Pipeline was successful Details

This commit is contained in:
FloatingGhost 2022-07-01 12:19:07 +01:00
parent 18fe9aa1b8
commit 8f7593fdba
2 changed files with 15 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -1,10 +1,10 @@
# Pleroma documentation
This project contains a documentation skeleton and a script to fill it in with data, the resulting documentation can be viewed at <https://docs-develop.pleroma.social>.
This project contains a documentation skeleton and a script to fill it in with data, the resulting documentation can be viewed at <https://akkoma.dev/main>.
## Contributing to the documentation
If you want to suggest an edit, please refer to the `pleroma/pleroma` and `pleroma/pleroma-fe` repos.
If you want to suggest an edit, please refer to the `AkkomaGang/akkoma` and `AkkomaGang/pleroma-fe` repos.
We use [mkdocs](https://www.mkdocs.org/) to build the documentation and have the [admonition](https://squidfunk.github.io/mkdocs-material/extensions/admonition/) extensions that make it possible to add block-styled side content like example summaries, notes, hints or warnings. If you are unsure of how a specific syntax should look like, feel free to look through the docs for an example.

13
docs/css/extra.css
View File

@ -16,3 +16,16 @@ code,
.codehilite pre {
font-weight: bold;
}
pre, code {
background: #f0e8ff !important;
}
code > .c1 > .hljs-comment {
color: #550f0f !important;
}
.bg-secondary {
background-color: #f0e8ff !important;
}