Skip to content

Latest commit

 

History

History
24 lines (13 loc) · 1.21 KB

README.md

File metadata and controls

24 lines (13 loc) · 1.21 KB
Raw

xap-docs

This repo hosts XAP documentation, based on markdown and Hugo.

Help Us Improve!

It's important for us to encourage your feedback and contribution. Contributing to this website is straightforward. Simply fork this repository, make your changes, test them with your local Hugo installation, and submit a pull request. We promise to review and comment on every pull request, and merge it if it makes sense.

Installation

  • Download Hugo and unzip it
  • Clone the xap-docs repository
  • To avoid merge problems, configure git to pull with rebase by typing the following from the command line: git config --global --bool pull.rebase true

Running

  • Simply run run.sh (Linux) or run.bat (Windows)
  • Browse to localhost:1313

(Optional) Navigation menu generation

The navigation menu is generated outside of Hugo via a script. The run.sh and run.bat scripts automatically genereate this menu by calling the generate-navbar.sh or generate-navbar.bat scripts before starting hugo. If you create a new page or change the weight of the pages, simply restart the script for the changes to take effect.