Coder Social home page Coder Social logo

carlnewton / avenue Goto Github PK

View Code? Open in Web Editor NEW
1.0 1.0 0.0 34 KB

Transform JSON files into static websites

License: MIT License

JavaScript 77.90% HTML 22.10%
documentation documentation-tool json json-documentation json-documentation-tool walkthrough walkthrough-documentation static-site static-site-generator static-site-generation

avenue's Introduction

Avenue

This project is a proof of concept to provide a solution for managing documentation that guides the reader based on their input. A walkthrough-based focus on documentation is something I haven't seen in the wild, and there may be good reasons for that. Time will tell!

Features

  • No setup! It all runs in JavaScript on a single page
  • Content is written to a JSON file to easily manage a decision flow

Demo

https://carlnewton.github.io/avenue/

Development

  • Run npm install gulp upon first downloading the repository.
  • Make changes in the /src directory and run gulp to build /dist/js/script.js or run gulp watch to have it build each time a file is updated in the /src directory.

avenue's People

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.