Skip to content

adamkrawczyk/docs_new

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

The official Husarion documentation

How to use locally

1. Prerequisites

Ensure you have the latest version of Node installed. It is also recommended to install Yarn as well.

  • Node version >= 8.x
  • Yarn version >= 1.5

2. Install node modules

Open docs_new dir, switch to website subdir and run:

$ cd <installation_path>/docs_new/website && npm install # or yarn install

3. Local build - images

In order to see pictures in your local build you have to comment line 37 in <installation_path>/docs_new/website/siteConfig.js file:

image

For contributors

Remember to remove comment before pushing to master branch!

4. Run documentation website locally

In website subdir run:

$ npm start # or yarn start

Load the example site at http://localhost:3000 if it did not already open automatically.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published