This repository contains the Antora playbook used to build the TigerGraph documentation site.
To build the site locally, run:
npm run buildThe build will be available in the build/ folder in the root directory.
|
Important
|
Though the files are all in the /build folder, you won’t be able to access other pages through the links if the files are not served by a server.
To preview locally, you can Run a local server to view the build. If you really don’t want to use a local server, edit the antora-playbook.yml file in your local environment, and change the html_extension_style under urls to default. This allows you to open the static files and have the links work.
|
To have Antora build the site from your local content source repository, change the corresponding content source in the file antora-playbook.yml to point to your local git repository.
See Use local content repositories on Antora’s documentation.
Watch Mode launches a local web server for preview. It will continue watching your local content source repository changes and rebuild the site.
npm run devYou can access the web server at http://localhost:5000.
To open the build, run:
$ npm i -g http-server
$ http-server build/site -c-1Upon launching the command, the local address of the web server will be displayed in your terminal. You should see the following output in your terminal:
Starting up http-server, serving build/site Available on: http://127.0.0.1:8080 http://192.168.1.8:8080 Hit CTRL-C to stop the server
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent