Giter Site home page Giter Site logo

passga / bonitasoft.github.io Goto Github PK

View Code? Open in Web Editor NEW

This project forked from bonitasoft/bonita-documentation-site

0.0 0.0 0.0 143.25 MB

The new solution under development for the Bonita Documentation

Home Page: https://bonitasoft.github.io/

License: GNU General Public License v2.0

JavaScript 81.99% Shell 7.22% Python 10.80%

bonitasoft.github.io's Introduction

New Bonita Documentation Site

DISCLAIMER: this is a work in progress.

Architecture

Static site generation based on Antora using Asciidoctor documentation content stored in various Git repositories.

Build

Requirements

Node 12.x (may work with newer versions, no guarantee). For more details, see the Antora installation guide.

While you can install Node from the official packages, we strongly recommend that you use nvm (Node Version Manager) to install and manage Node. Follow the nvm installation instructions to set up nvm on your machine.

Note
all npm commands are intended to be run from the repository root folder.

Build the static site for production

Run

npm install
npm run build

The static site is then available in the build/site folder.

Local development

The antora CLI is available by calling ./node_modules/.bin/antora --version

Building for local developments

For a site that can be load from local disk

npm run local:build-static

For a site to be served by the development http server

npm run local:build
Using local documentation content repository

This activates the Antora author mode. The local content of the repository is used instead of fetching the remote one.

It provides a fast feedback loop as you don’t need to push nor commit content as the current work

Note
Repositories location

This requires to clone all repository sources locally is the parent folder of this project. For instance

root
  |
  -- bonita-doc
  |
  -- bonita-ici-doc
  |
  -- bonitasoft.github.io
npm run local:build-static:local-content

http server

Once the static site is build, you can run npm run serve and access to http://localhost:8080/ to check if everything is working correctly (urls in taxononmy, links, …​.).

You can rebuild the site while the server is running, updated files are directly considered by the server (no cache).

Documentation

See the dedicated folder.

bonitasoft.github.io's People

Contributors

benjaminparisel avatar passga avatar tbouffard avatar uguy avatar vishalthapaliya 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.