Giter Club home page Giter Club logo

oqtane.docs's Introduction

Oqtane Docs Builder

This project generates the documentation for Oqtane using docfx.

It's explained in detail on https://docs.oqtane.org/articles/documentation/

Setup

To set everything up, do the following:

In some folder (like c:\projects\oqtane) pull this repo and also the oqtane.framework. You should then have something like

  • some-root\oqtane.docs
  • some-root\oqtane.framework

Run with Visual Studio

Open the Oqtane Docs Builder.sln solution in this folder and just rebuild everything.

The final docs are generated into the /docs folder.

Test locally

As some of the stuff needs JS which only runs well from HTTP, you should setup IIS to publish the /docs folder on any domain you want - like docs.oqtane.me.

Publish

When you push back this repo github will automatically publish the updated documentation.

oqtane.docs's People

Contributors

ijungleboy avatar gjwalk avatar adefwebserver avatar sbwalker 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.