Getting Started with Writing Markdown arcticles
Step 1: Access Your Wiki
- Log in to your Wiki.js instance using your credentials.
- Once logged in, navigate to the wiki or space where you want to create or edit articles.
Step 2: Create a New Article
- Click on the "+ New" button or equivalent to start creating a new article.
Step 3: Write Content
- You'll be presented with a text editor that allows you to write and format your content using Markdown.
Step 4: Markdown Basics
-
Use Markdown syntax to format your text. Here are some common Markdown elements:
-
Headings:
# Heading 1 ## Heading 2 ### Heading 3
-
Lists:
- Item 1 - Item 2 - Subitem A 1. Numbered item 1 2. Numbered item 2
-
Links:
[Link Text](http://example.com)
-
Images:
![Alt Text](image-url.jpg)
-
Emphasis:
*italic* **bold**
-
Code:
`inline code` ```python # code block
-
Quotes:
> This is a quote.
-
Headings:
Step 5: Save and Preview
- Use the "Save" button to save your changes.
- Click "Preview" to see how your article will look when published.
Step 6: Categories and Tags
- Organize your articles by adding them to relevant categories and tagging them appropriately.
Step 7: Publish
- Once you're satisfied with your article, click "Publish" to make it accessible to users.
Step 8: Editing and Revisions
- You can always edit articles by clicking the "Edit" button.
- Wiki.js keeps track of article revisions, allowing you to revert to previous versions if needed.
Tutorial: Writing Markdown Articles
Now, let's dive deeper into writing Markdown articles in Wiki.js. Here's a basic example:
# My Markdown Article
This is a simple Markdown article created using Wiki.js.
## Section 1: Introduction
In this section, we introduce our topic.
- Bullet points are useful for lists.
- They make information easy to digest.
## Section 2: Writing Code
You can include code snippets using backticks:
```javascript
function sayHello() {
console.log('Hello, World!');
}
Section 3: Links and Images
Links are created like this: n-cloud.
Images are displayed like this:
Section 4: Emphasis
You can emphasize text using italics or bold.
Section 5: Quotes
This is a block quote. It can be used for citations or highlighting important information.Use (>) to start
That's it! You've learned the basics of writing Markdown articles in Wiki.js. Feel free to explore more advanced features and formatting options as you create your documentation.
No Comments