Skip to content

tylerforesthauser/USB-Docs

 
 

Repository files navigation

USB Docs

This is the git repository for Ultraseedbox Docs powered by BookStack. This is an ongoing project and is being updated as new guides are synced to Bookstack. There maybe some missing guides and inconsistencies.

How to contribute?

To contribute, just submit a PR here. Once approved, it will be uploaded to USB Docs.

Formatting

Note that all of the articles in here and in the docs site uses mostly Markdown with some HTML, which are listed below.

Images

Images needed to be in the center.

<p align="center"><img src="https://i.ibb.co/XS9Q7C3/22601782810-cbe3ede5f5-o-focus-none-original.jpg"></p>

Callouts

Should you need to use callouts, refer below.

Info

<p class="callout info">Your info text here.</p>

Success

<p class="callout success">Your success text here.</p>

Warning

<p class="callout warning">Your warning text here.</p>

Danger

<p class="callout danger">Your danger text here.</p>

Add <c></c> before the callout for markdown within callout tags to work. Add a line before it.

<c><p class="callout info">Your info text here [with some links](https://www.example.com/).</p></c>

replace.sh script

To automate formatting, you can use replace.sh to automatically replace the markdown formatting to what is listed above. It just needs the following:

  • Callout tags should be in this format
<callout {warning,info,danger,success}>Text here. You might need to <br> if you want</callout>

You can run the script by doing the following

bash replace.sh /path/to/markdown.md

License

This project is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.

CC BY-SA 4.0

About

Git repository for USB Docs

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Shell 100.0%