-
Notifications
You must be signed in to change notification settings - Fork 2
How To: make a swerver drive, make a guide #12
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Changes from all commits
011f8c8
a23305b
da9ac6f
f33540f
04207fd
ffa8216
d2df0b7
66dca93
e66daa5
dcceeee
8e0420b
fafd6c6
d89aed8
c810745
be4e249
b3a8fff
d0b9cfb
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I see that you are setting the syntax language to java everywhere for code blocks- you can actually specify whichever language you want. To specify markdown for the code block you can use Also, it would be nice to specify that the docs are made with Material for MKDocs. They have their own documentation website that shows you how to use many of the more complicated features. This link could go in a "See also" or "Further Reading" section.
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. There is also a page from the old documentation that is for writing new documentation:
I also like how this guide explains how to open the editor to get started.
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Also, be careful to specify when you're describing standard Markdown or extended Markdown. |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,77 @@ | ||
| # Making Your Own Guide | ||
|
|
||
| ## Intro | ||
| Making your own guide isn't at all hard if you know how to do it that is. | ||
| This guide "Should" be able to tell you all the things of the guides. | ||
|
|
||
| ## Making a Guide | ||
| Guides are what teach people how to do something that they would otherwise ask someone. More or less, I had to find out how to make my own guide and I had no idea how to make it, and I don't want others having to relearn it either too! | ||
|
|
||
| To make your own, there are thing you need to know: | ||
|
|
||
| 1. Format | ||
| Format is what make the code understand (yes, this is code, ish). This is the most critical: | ||
| You can make stuff like links: | ||
| ```java | ||
| "[Title of link or name](Your link)" | ||
| ``` | ||
| To directly enter a link: | ||
| ```java | ||
| <Your link> | ||
| ``` | ||
| Also you can make code (as seen above): | ||
| ```java | ||
| "```(language of code) (if you want a title ```(language) title="name") | ||
| put your code here | ||
| then end with: | ||
| "``` | ||
| for the end | ||
| ``` | ||
| The code auto puts color for you so you dont have to. | ||
|
|
||
| There is also ways to do the "`" without code to do linkless text: | ||
| `text` | ||
| ```java | ||
| `text` | ||
| ``` | ||
|
|
||
| 2. Multi tabs | ||
| Multi tabs are just things for you to switch between for like different intructions for code and such. | ||
| do like this: | ||
| ```java | ||
| === (Code Language) | ||
| ``` | ||
| to make it. | ||
| There are many uses like below: | ||
|
|
||
| === "Java" | ||
| This is the java tab | ||
|
|
||
| === "Other coding language" | ||
| yep :> | ||
|
|
||
| Thats how they work | ||
|
|
||
| 3. Titles | ||
| There are many different titles to use | ||
| 1 "#" gets you the main title | ||
| # (Title) | ||
| 2 "#" gets you a header | ||
| ## (Header) | ||
| 3 "#" gets you a subheader | ||
| ### (SubHeader) | ||
| Make sure there is a space between the "#" and the works | ||
|
|
||
| 4. Numbering things | ||
| You might have been seeing thoose numbers I have been using. | ||
| They are make with #. to make them. | ||
| Like: | ||
| ```java | ||
| 1. (Text goes here) | ||
| 2. | ||
| 3. | ||
| 4. | ||
| ect... | ||
| ``` | ||
|
|
||
| This was made by myself so hope you like it, and have fun making guides! |
Uh oh!
There was an error while loading. Please reload this page.