https://github.com/tigergraph/cloud-docs
TG cloud doc source files
https://github.com/tigergraph/cloud-docs
Last synced: 16 days ago
JSON representation
TG cloud doc source files
- Host: GitHub
- URL: https://github.com/tigergraph/cloud-docs
- Owner: tigergraph
- Created: 2021-09-13T18:19:32.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2026-03-11T20:52:14.000Z (about 2 months ago)
- Last Synced: 2026-03-11T21:54:59.622Z (about 2 months ago)
- Language: JavaScript
- Size: 54.4 MB
- Stars: 2
- Watchers: 5
- Forks: 9
- Open Issues: 2
-
Metadata Files:
- Readme: README.adoc
Awesome Lists containing this project
README
= TigerGraph Cloud Documentation
This repository contains the user-facing documentation for TigerGraph Cloud.
This repository only contains the source files for the published documentation.
To view the published version, see link:https://docs.tigergraph.com/cloud[TigerGraph Cloud Documentation].
== Contribution
For instructions on how to contribute to this repository, see link:https://github.com/tigergraph/doc-site/blob/main/contribution.adoc[Contribution guidelines].
== Install dependencies
To install dependencies, navigate to this repository and run:
[,console]
----
npm install
----
== Build site locally
To build the site locally, run:
[,console]
----
npm run build
----
The 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 <>. 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.
=== Build from your local content source repository
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 https://docs.antora.org/antora/2.3/playbook/content-source-url/#local-urls[Use local content repositories] on Antora's documentation.
== Watch Mode
Watch Mode launches a local web server for preview. It will continue watching your local content source repository changes and rebuild the site.
[,console]
----
npm run dev
----
You can access the web server at http://localhost:5000[http://localhost:5000].
== Run a local server to view the build
To open the build, run:
[,console]
----
$ npm i -g http-server
$ http-server build/site -c-1
----
Upon 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
----