https://github.com/metadream/deno-docify
A super easy-to-use markdown document preview framework in Deno.
https://github.com/metadream/deno-docify
document-preview markdown markdown-preview
Last synced: 6 months ago
JSON representation
A super easy-to-use markdown document preview framework in Deno.
- Host: GitHub
- URL: https://github.com/metadream/deno-docify
- Owner: metadream
- Created: 2023-02-25T16:07:57.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-05-23T12:33:49.000Z (about 1 year ago)
- Last Synced: 2025-09-24T05:53:17.339Z (9 months ago)
- Topics: document-preview, markdown, markdown-preview
- Language: HTML
- Homepage: https://jsr.io/@focal/docify
- Size: 36.1 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Deno-Docify
A super easy-to-use markdown document preview framework in Deno.
## Example
- Demo: https://docify.deno.dev
- Source: https://github.com/metadream/tech-docs
## Usage
1. Create a start file with any name (ex. `start.ts`) in your document folder
root. The content of the file is as follows:
```typescript
// start.ts
import "jsr:@focal/docify@1.0.10";
```
Add a `deno.json` file in the same directory with the following content:
```json
{
"compilerOptions": {
"experimentalDecorators": true,
"emitDecoratorMetadata": true
}
}
```
2. Create `SUMMARY.md` and `README.md` in your document folder root. The
contents of the summary will be rendered in the left navigation side of the
page, and README file will be used as homepage content.
A typical `SUMMARY.md` contains the following content. Among them, metadata
between `---` and first-level title are not required.
```markdown
---
name: My Document
logo: https://example.com/logo.png
footer: Copyright (c) 2023
---
# TABLE OF CONTENT
## Get Started
- [Installation](/folder1/installation.md)
## API References
- [Properties](/folder2/properties.md)
- [Methods](/folder2/methods.md)
```
3. Create markdown files with corresponding names under folder1 and folder2. The
final directory structure is as follows:
```
├─ folder1
│ └─ installation.md
├─ folder2
│ ├─ properties.md
│ └─ methods.md
├─ README.md
├─ SUMMARY.md
└─ start.ts
```
4. Run start file.
```bash
deno run --allow-net --allow-read start.ts
```