Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.refile.co/llms.txt

Use this file to discover all available pages before exploring further.

Markdown is the lightweight, easy to learn, human-readable markup language that powers refile. Think of markdown as a way to write text while specifying its formatting. This is just a rough guide, for more information on markdown, please visit markdowntutorial.com.

​
Headings

To create headings, add pound symbols (#) at the beginning of a line, followed by a space. The number of pound symbols corresponds to the heading level: 
# Heading level 1

## Heading level 2

### Heading level 3

#### Heading level 4

##### Heading level 5

###### Heading level 6
Best Practices for Headings:
  • Always include a space between the # symbols and your heading text
  • Leave a blank line before and after headings for better readability

​
Text Formatting

​
Bold Text

To make text bold, add two asterisks or two underscores before and after the text: 
**This text is bold**
**This text is also bold**
You can also make part of a word bold using asterisks: This is a **bold** word

​
Italic Text

To make text italic, add one asterisk or one underscore before and after the text: 
_This text is italic_
_This text is also italic_
Like with bold text, you can italicize part of a word: This is an *italicized* word

​
Tables

Tables are created using pipes (|) and dashes (-): 
| Header 1 | Header 2 |
| -------- | -------- |
| Cell 1   | Cell 2   |
| Cell 3   | Cell 4   |
This renders as:
Header 1Header 2
Cell 1Cell 2
Cell 3Cell 4

​
Text Alignment in Tables

You can align text in columns by adding colons (:) to the header row: 
| Left-aligned | Center-aligned | Right-aligned |
| :----------- | :------------: | ------------: |
| Content      |    Content     |       Content |
  • :-- Left alignment
  • :-: Center alignment
  • --: Right alignment

​
Lists in Markdown

Markdown supports several types of lists to organize your content effectively:

​
Unordered Lists

Create unordered (bulleted) lists using hyphens, asterisks, or plus signs followed by a space: 
- Item one
- Item two
- Item three

* Item one
* Item two
* Item three

- Item one
- Item two
- Item three
All three methods produce the same bulleted list output, though some editors may only support hyphens (-).

​
Ordered Lists

Create numbered lists by starting each line with a number followed by a period and a space: 
1. First item
2. Second item
3. Third item
To start numbering from a specific value, use that number for the first item: 
23. Twenty-three
24. Twenty-four
25. Twenty-five

​
Nested Lists

Create hierarchical lists by indenting with spaces (typically 2 or 4 spaces): 
- First level item
  - Second level item
  - Another second level item
- Another first level item
  1. Numbered sublist
  2. Another numbered item

​
Task Lists

We support task lists with checkboxes: 
- [ ] Unchecked task
- [x] Completed task

​
Example Document

Here’s a complete example that demonstrates the markdown features we’ve covered: 
# My Project Documentation

## Introduction

This document provides an **overview** of the _amazing_ features in our project. It serves as a **_quick reference_** for team members.

## Features

### Core Functionality

- [x] User authentication
- [x] Data storage
- [ ] Export capabilities
- [ ] Advanced analytics

### Technical Specifications

| Feature | Status  | Priority |
| :------ | :-----: | -------: |
| Login   |  Done   |     High |
| Search  |  Done   |   Medium |
| Reports | Pending |      Low |

## Implementation Notes

1. Install dependencies
   1. Core libraries
   2. Development tools
2. Configure settings
3. Run initialization script

### Code Example

Our system uses the following approach:

1. Define data models
2. Create API endpoints
3. Implement frontend components

## Next Steps

We need to focus on completing the remaining tasks while maintaining our **high quality standards**.

For more information, visit our [documentation portal](https://example.com/docs).
This example demonstrates headings of different levels, text formatting, task lists, tables with alignment, ordered and nested lists, and links - all of which were covered in the previous sections. You can copy this example and modify it to create your own structured documents in refile.