https://github.com/fullhexventures/vector-charts-docs
Documentation website for the VectorCharts.com platform.
https://github.com/fullhexventures/vector-charts-docs
documentation hugo nautical-charts netlify vector-charts website
Last synced: over 1 year ago
JSON representation
Documentation website for the VectorCharts.com platform.
- Host: GitHub
- URL: https://github.com/fullhexventures/vector-charts-docs
- Owner: fullhexventures
- Created: 2024-10-13T23:45:34.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-20T04:23:10.000Z (over 1 year ago)
- Last Synced: 2025-01-24T11:12:06.091Z (over 1 year ago)
- Topics: documentation, hugo, nautical-charts, netlify, vector-charts, website
- Language: CSS
- Homepage: https://docs.vectorcharts.com
- Size: 12.4 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
This is the source code that runs the [VectorCharts documentation website](https://docs.vectorcharts.com/). If you are looking for the Vector Charts product, please head back to https://vectorcharts.com.
## How to Contribute
- If you have a request for expanded documentation or question that is not answered in the docs, please open an issue!
- For bug reports or feature requests for the VectorCharts.com platform itself, please use the [Contact Us form](https://vectorcharts.com/contact-us).
- PRs or issues are welcome for any expanded documentation, spelling/grammar issues, or factual errors.
---
## Developer's Guide
This repository uses Hugo to generate a static site from markdown files. The project also includes a custom theme, specifically designed for the documentation site. The theme sets up sidebar menus, headers and footers, etc.
The site is deployed using Netlify; The `master` branch is deployed to the production site.
### Deploy Status
|Branch|Deploy Status|Target|
|------|-------------|------|
|`master`||https://docs.vectorcharts.com/|
### Development
Please install [Hugo](https://gohugo.io/).
To run a development server, use:
```
hugo serve
```
To build and export the site to static HTML, use:
```
hugo
````
This will build the static site to the `public/` directory as HTML. These files should not be uploaded to git; they are ignored and will be built by Netlify during the automated deployment.