Skip to content

compayer/compayer-docs

Repository files navigation

Compayer Documentation

License: CC BY 4.0

Documentation site for Compayer.

Compayer

Getting started

Try dashboards out on real datasets.

You can start using Compayer

Building

To view the documentation site locally, you need to clone this repository:

git clone https://github.com/compayer/compayer-docs.git

Then to view the docs in your browser, run Hugo from the root project directory and open up the started Web Server link:

$ hugo server

Started building sites ...
.
.
Serving pages from memory
Web Server is available at http://localhost:1313/ (bind address 127.0.0.1)
Press Ctrl+C to stop

Contributing, Support, Feature Requests

If you like our documentation then you can put a ⭐️ on it and perhaps contribute new examples or help us keep it up to date.

If you have an idea of how to improve Compayer (or any of the product parts, including the documentation) or have general feedback, you're welcome to submit a feature request.

If you have a question and can't find the answer in the docs, we consider it a bug in our documentation. Please raise an issue and describe what exactly you're trying to do and where are our docs not good enough. We'll do our best to reply in a meaningful time.

Compayer welcomes contributions from anyone and everyone. Please refer to our contribution guide to learn more.

License

The project is available as open source under the terms of the CC BY 4.0 License.

About

Compayer documentation and API Reference sites source code

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 5