Guidejar

How to import a guide in markdown format?

Learn how to import Markdown content into Guidejar and convert it into a structured guide

1

Click on "Create"

Click on "**Create**"
2

Click on "Import Guide"

Click on "**Import Guide**"
3

Paste your Markdown content into the editor as per the given standard format. Use the following format to import your guide:

1st line: Title 2nd line: Description Steps: Separated by `---`

Step Formatting:

- Start with `#` for a section header - Start with `!` for an alert/warning - Start with `*` for a tip - Include images using: `![alt](image-url)`

Paste your Markdown content into the editor as per the given standard format.
Use the following format to import your guide:
```
1st line: Title
2nd line: Description
Steps: Separated by `---`
```
Step Formatting:
```
- Start with `#` for a section header
- Start with `!` for an alert/warning
- Start with `*` for a tip
- Include images using: `![alt](image-url)`
```
4

Click on "Import"

Click on "**Import**"
5

Tada 🎉 You've created a complete guide just with plain text.

Tada 🎉 You've created a complete guide just with plain text.

Frequently asked questions

  • Can I add images using the import option?

    Yes, you can include images during import. Make sure the image is hosted online and use the following format:![alt text](image-url)

  • Can I add steps to an existing guide by importing them from another guide or from a PDF/DOCX?

    Yes. You can import steps from another guide or from PDF/DOCX files—see: