add MD editor note
All checks were successful
Build and Deploy Documentation / build-and-deploy (push) Successful in 19s
All checks were successful
Build and Deploy Documentation / build-and-deploy (push) Successful in 19s
This commit is contained in:
12
Readme.md
12
Readme.md
@@ -1,9 +1,3 @@
|
||||
---
|
||||
search:
|
||||
exclude: true
|
||||
---
|
||||
|
||||
|
||||
# Overview
|
||||
|
||||
This is the collection of Control Systems related documentation.
|
||||
@@ -11,4 +5,8 @@ The documentation is build via a gitea action (gitea-pages) and the content is a
|
||||
|
||||
To change stuff, simply edit the the Markdown and/or rst files and push to the git repository. The rendered page will update a few seconds (up to a minute) afterwards (Don't forget to refresh your browser cache for the page!).
|
||||
|
||||
> Ideally convert the .rst files you touch to Markdown!
|
||||
> Ideally convert the .rst files you touch to Markdown!
|
||||
|
||||
!!! info not familiar with Markdown?
|
||||
|
||||
Try to use online WYSIWYG editors as [StackEdit.io](https://stackedit.io/) or [HackMD.io](https://hackmd.io/).
|
||||
|
||||
Reference in New Issue
Block a user