https://github.com/metadream/deno-book

A super easy-to-use markdown document preview framework in Deno.
https://github.com/metadream/deno-book

document-preview markdown markdown-preview

Last synced: 5 days ago
JSON representation

A super easy-to-use markdown document preview framework in Deno.

• Host: GitHub
• URL: https://github.com/metadream/deno-book
• Owner: metadream
• Created: 2023-02-25T16:07:57.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2024-09-14T10:01:13.000Z (2 months ago)
• Last Synced: 2024-10-14T13:18:19.341Z (about 1 month ago)
• Topics: document-preview, markdown, markdown-preview
• Language: HTML
• Homepage: https://deno.land/x/book
• Size: 17.6 KB
• Stars: 1
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Deno-Book

A super easy-to-use markdown document preview framework in Deno.

## Demo

https://tech-docs.deno.dev

## 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:

```

// start.ts

import "https://deno.land/x/book/mod.ts";

```

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.

```

---

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.

```

deno run --allow-net --allow-read start.ts

```