Writing Guide
Getting Started with the Editor
Blogify uses a powerful Markdown-based editor that allows you to focus on your writing while providing rich formatting options. Whether you are writing a technical deep-dive or a personal story, you can use standard Markdown syntax and LaTeX for mathematical expressions.
The editor is split into a title field, a tag selector, and a main content area where you write your post body.
Markdown Fundamentals
Markdown is a lightweight markup language that uses plain text to format your content. Here are the most common formatting options available in Blogify:
Text Formatting
- Bold: Wrap text in double asterisks
**bold text** - Italic: Wrap text in single asterisks
*italic text* - ~~Strikethrough~~: Wrap text in double tildes
~~strikethrough~~ Inline Code: Wrap text in backticks`code`
Headers
Use the # symbol followed by a space to create headings:
# Level 1 Heading (Main Title - use sparingly in body)
## Level 2 Heading (Major Sections)
### Level 3 Heading (Sub-sections)
Lists
Create organized lists easily:
- Item 1
- Item 2
- Nested Item
1. First point
2. Second point
Links and Blockquotes
To insert a link: [Display Text](https://example.com).
To create a blockquote for citations or emphasis:
> "This is a blockquote that helps highlight important thoughts or quotes."
Writing Mathematical Expressions (LaTeX)
Blogify supports LaTeX through the remark-math and rehype-katex plugins. This is perfect for students, researchers, and developers who need to share formulas.
Inline Math
To include a formula within a sentence, wrap the LaTeX code in single dollar signs $.
Example: $E=mc^2$ renders as $E=mc^2$.
Block Math
For complex formulas that need their own line, use double dollar signs $$.
Example:
$$
\frac{-b \pm \sqrt{b^2 - 4ac}}{2a}
$$
Adding Images and Media
There are two ways to handle images in Blogify:
1. Featured Image
When creating or editing a post, use the Featured Image upload button. This image appears at the top of your post and acts as the thumbnail in the community feed.
2. Inline Images
To place images within your text:
- Click the Upload Image icon within the editor toolbar (or use the upload action in the edit view).
- Once uploaded, Blogify automatically generates a Markdown snippet like
. - You can change the text inside the brackets
[]to add Alt Text for better accessibility.
Code Blocks
For technical writing, you can use triple backticks to create syntax-highlighted code blocks:
```javascript
function greet() {
console.log("Welcome to Blogify!");
}
```
Tags and Organization
At the bottom of the editor, you will find the Tags field.
- Separate tags with commas (e.g.,
Technology, Tutorial, React). - Tags help other users find your content through the search and tag-discovery features.
- Keep tags concise and relevant to improve your post's visibility.
Best Practices for Blogify
- Use H2 and H3: Use
##and###for your subheadings to maintain a clean visual hierarchy. - Check Dark Mode: Blogify is optimized for both light and dark modes. Preview your post if possible to ensure your images and formatting look great in both.
- Save Often: Ensure you click "Publish" or "Update" to save your progress to the database.