📝 Documentation Generator built with Deno

Related tags

Learning resource documentation docs typescript deno
Overview

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

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:

vale init demo
vale watch demo

Please give it a ⭐ Star if you like it :)

Made by Marc Espín

MIT License

You might also like...

Dyte's documentation portal built with Docusaurus.

Dyte's documentation portal built with Docusaurus.

Dyte Docs Dyte's documentation portal, built with Docusaurus. Explore the docs » View Demo · Report Bug · Request Feature Table of Contents About the

Jan 1, 2023

[WIP] WebGL API implementation for Deno, built on GLFW using FFI.

Note I'm no longer working on this project because I have just realized macOS does not support OpenGL ES API, and adding Desktop GL backend to this mo

Jun 11, 2022

A fast and optimized middleware server with an absurdly small amount of code (300 lines) built on top of Deno's native HTTP APIs

A fast and optimized middleware server with an absurdly small amount of code (300 lines) built on top of Deno's native HTTP APIs with no dependencies. It also has a collection of useful middlewares: log file, serve static, CORS, session, rate limit, token, body parsers, redirect, proxy and handle upload. In "README" there are examples of all the resources. Faster's ideology is: all you need is an optimized middleware manager, all other functionality is middleware.

Dec 28, 2022

Crate a full-stack web framework built with deno!

crate crate is a fullstack web framework built on deno! available on: [deno.land/x] [github] get started all you need to do is make two files. serious

Nov 11, 2022

Shifty is a tiny zero-dependency secrets generator, built for the web using TypeScript.

Shifty is a tiny zero-dependency secrets generator, built for the web using TypeScript. Installation yarn add @deepsource/shifty Usage Shifty is built

Nov 24, 2022

API Documentation Browser

DevDocs — API Documentation Browser DevDocs combines multiple developer documentations in a clean and organized web UI with instant search, offline su

Jan 9, 2023

Open Source projects are a project to improve your JavaScript knowledge with JavaScript documentation, design patterns, books, playlists.

Open Source projects are a project to improve your JavaScript knowledge with JavaScript documentation, design patterns, books, playlists.

It is a project I am trying to list the repos that have received thousands of stars on Github and deemed useful by the JavaScript community. It's a gi

Aug 14, 2022

Support documentation for Decrypt's applications, token, and community.

Website This website is built using Docusaurus 2, a modern static website generator. Installation npm install Local Development npm start This command

Dec 8, 2022

Automatically generated documentation for the Valorant API endpoints the client uses internally.

Valorant API Docs To read documentation and get started, see Docs This is a project designed to automatically document Valorant endpoints based on a J

Dec 25, 2022
Comments
  • 🔧 Standardization

    🔧 Standardization

    Add Prettier and EditorConfig to have the same code formatting across all the developpers. Add a file to recommend to the developer to install various extensions related to the project.

    opened by LucasCtrl 3
  • [feat] Themes

    [feat] Themes

    In the website directory create a configuration file or use the manifest.json to tell the builder to use a specific theme. The themes will be stored under the directory called themes. Each themes need to have a specific name that matches the theme defined in the configuration file.

    Eg:

    ├── my-website
│   ├── manifest.json or config.json
│   ├── themes
│   │   ├── default
│   │   ├── theme1   <- use this theme
│   │   │   └── main.css
│   │   └── theme2

    {
  "theme": "theme1" // Tell the builder to use the theme "theme1"
}

    Each themes should have their main file called main for simplifying the building process.

    Maybe improve this feature with issue #6 which can support SASS/SCSS out of the box.

    enhancement 
    opened by LucasCtrl 1
  • [feat] SASS/SCSS integration

    [feat] SASS/SCSS integration

    Automatically guess the file type by its extension and use the appropriate pre-processor loader. Transform SASS/SCSS to CSS and minimize the files on build

    opened by LucasCtrl 0
  • [feat] Make a deployment guide for Deno Deploy

    [feat] Make a deployment guide for Deno Deploy

    Add an example to /docs (https://vale.deno.dev) on how to deploy a Vale website on Deno Deploy.

    https://github.com/marc2332/vale/blob/main/build_website.ts

    https://github.com/marc2332/vale/blob/main/website.ts

    documentation enhancement 
    opened by marc2332 1
Releases(0.1.4)
Owner
Marc Espín
Software Developer Student 👨‍💻 and Intern at @ALBA-Synchrotron
Marc Espín
GitHub https://vale.deno.dev
A small, but powerful HTTP library for Deno & Deno Deploy, built for convenience and simplicity

Wren Wren is a small, but powerful HTTP library for Deno & Deno Deploy, built for convenience and simplicity. convenient aliases for HTTP responses au

Jakub Neander 69 Dec 12, 2022
Automatic documentation generator for ESLint plugins and rules.

eslint-doc-generator Automatic documentation generator for ESLint plugins and rules. Generates the following documentation based on ESLint and top ESL

Bryan Mishkin 64 Dec 27, 2022
This is a simple boilerplate for a Deno website, deployed with Deno Deploy.

Simple Deno Website Boilerplate This is a simple website boilerplate built using Deno and deployed using Deno Deploy. Demo at simple-deno-website-boil

Bruno Bernardino 15 Dec 3, 2022
TypeSafe MongoDB Atlas Data API SDK for Deno & Deno Deploy

Atlas SDK atlas_sdk is a TypeSafe MongoDB Atlas Data API SDK for Deno & Deno Deploy Links Docs Import Replace LATEST_VERSION with current latest versi

Erfan Safari 20 Dec 26, 2022
Deno bindings for yoga, using Deno FFI.

deno_yoga Deno bindings for yoga, using Deno FFI. Usage flags: --allow-ffi: Requires ffi access to "yogacore.dll", "libyogacore.so", "libyogacore.dyli

迷渡 6 Feb 11, 2022
🛣️ A tiny and fast http request router designed for use with deno and deno deploy

Rutt Rutt is a tiny http router designed for use with deno and deno deploy. It is written in about 200 lines of code and is pretty fast, using an exte

Denosaurs 26 Dec 10, 2022
deno-ja (Deno Japanese community) showcase

Showcase Deno本家よりも気軽に作ったものを公開できるようなShowcaseです。 スクリーンショットの撮影方法 短めのidを決めていただいて、下記のようにスクリプトを実行してください。 deno task screenshot [url] [id] ※エラーが出る場合は、下記を実行してみ

deno-ja 17 Oct 28, 2022
A command-line tool to manage Deno scripts installed via deno install

??️ nublar nublar is a command-line tool to manage your scripts installed via deno install. ??️ Installation deno install --allow-read --allow-write -

Shun Ueda 16 Dec 26, 2022
Obsidian text generator Plugin Text generator using GPT-3 (OpenAI)

is a handy plugin for Obsidian that helps you generate text content using the powerful language model GP

null 356 Dec 29, 2022
Types generator will help user to create TS types from JSON. Just paste your single object JSON the Types generator will auto-generate the interfaces for you. You can give a name for the root object

Types generator Types generator is a utility tool that will help User to create TS Interfaces from JSON. All you have to do is paste your single objec

Vineeth.TR 16 Dec 6, 2022