Git Product home page Git Product logo

docs's Introduction

Documentation

Currently available at https://docs.projectalice.io

Building locally

This wiki is build using vuepress. If you want to test it locally you need to build it:

vuepress build docs

Serve the website locally e.g. with http-server and not with the inbuilt server!

Jetbrain's Webstorm

Webstorm integrates a run/debug configuration tool that comes very handy for this. This package uses http-server as webserver.

  • Make sure you have node.js installed
  • Clone this repo in Webstorm
  • Open this repo's package.json file
    • Webstorm should automatically propose to install the not yet installed dependencies
    • If now, click on the packages that should be highlighted and alt + enter them, choosing install xxx for each
  • Open the Run/Debug configuration tool
  • Create 2 new npm configurations:
    • Build
      • package.json: Pointing to the repo's package.json file
      • Command: run
      • Script: build
    • Serve
      • package.json: Pointing to the repo's package.json file
      • Command: run
      • Script: serve
      • Arguments: -O
  • Now you can first build the sources and then serve them as a local http server, all in one click! The serve command will give you the url to browse your local documentation website!

docs's People

Contributors

psychokiller1888 avatar philipp2310 avatar maxbachmann avatar dependabot[bot] avatar lazzaau avatar projectalicebot avatar wraithrmm avatar thehacker avatar hipitihop avatar jbperrin88 avatar poulsp 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.