https://github.com/marc2332/vale

📝 Documentation Generator built with Deno
https://github.com/marc2332/vale

deno docs documentation typescript

Last synced: 4 months ago
JSON representation

📝 Documentation Generator built with Deno

• Host: GitHub
• URL: https://github.com/marc2332/vale
• Owner: marc2332
• License: mit
• Created: 2022-03-27T19:49:42.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2022-04-02T11:15:57.000Z (almost 3 years ago)
• Last Synced: 2024-10-03T08:22:22.368Z (4 months ago)
• Topics: deno, docs, documentation, typescript
• Language: TypeScript
• Homepage: https://vale.deno.dev
• Size: 114 KB
• Stars: 20
• Watchers: 3
• Forks: 4
• Open Issues: 3
• Metadata Files:
  • Readme: readme.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
> WORK IN PROGRESS ⚠️ Expect breaking changes ⚠️

# 📝 Vale

**Vale** is a static documentation generator, designed for speed, simplicity and

readability. Built with Deno, but you can use it for any project. Inspired by

[Deno Manual](https://deno.land/manual) and

[mdbook](https://rust-lang.github.io/mdBook/).

## 🎉 Features

- Multiple languages

- Code blocks support

I plan to add other features such as a searcher, third-party links on the

navbar, "Edit on Github" link, page tags, SSR, themes, copy button in code

blocks, etc...

## 📦 Installation

Install Vale with Deno:

```bash

deno install --allow-env --allow-read --allow-write --allow-net --unstable -n vale https://deno.land/x/vale/mod.ts

```

Create and run a basic project:

```bash

vale init demo

vale watch demo

```

Please give it a [⭐ Star](https://github.com/marc2332/vale) if you like it :)

Made by [Marc Espín](https://github.com/marc2332)

MIT License