Giter Club home page Giter Club logo

academy's Introduction

OneArmy Docs Demo

This repo is for testing the integration of Docusaurus static site generation within the OneArmy platform. The code is hosted at:

https://onearmy.github.io/academy/

Building locally

It isn't particularly well-optimised for external contribution (yet!), but if you really want to try it out:

Installation

  1. Install Node
    Follow instructions at https://nodejs.org/en/download/

  2. Install Yarn
    Follow instructions at https://yarnpkg.com/lang/en/docs/install

  3. Clone the repo
    Either use your favourite git client client or
    git clone https://github.com/onearmy/academy.git

  4. Install website dependencies

cd academy/website

yarn install

Run locally

yarn start

View local changes

The above command will automatically start up a local development server with live-reload, and open in a web browser. Any changes you make should automatically recompile and refresh your browser window

Development

For information on how to develop with docusaurus see:
https://docusaurus.io

Deployment

The site is configured to automatically build whenever changes are made to the master branch, and the generated html is deployed from the gh-pages branch.

You can view build status at https://travis-ci.org/onearmy/academy
You can see live deployment at : https://onearmy.github.io/academy/

Additionally all PRs will have a live preview link created, which can be viewed on the github PR thread.

License

Different parts of this project are under different license conditions

  • Content: All our content is licensed under Creative Commons Attribution - Sharealike International 4.0. You can read a summary of that here, or check out the full license.
  • Code: Code license for the academy site is GPL-3.0 License.

academy's People

Contributors

davehakkens avatar saskiarysenbry avatar martisj avatar katharinaelleke avatar chrismclarke avatar jaklatt92 avatar hbirdj avatar darigovresearch avatar mariacastiel avatar sovesove avatar bengamma avatar thisislawatts avatar dependabot[bot] avatar thisismattia avatar nicoparies avatar maris-ka 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.