Skip to content

Latest commit

 

History

History
51 lines (31 loc) · 1.88 KB

README.md

File metadata and controls

51 lines (31 loc) · 1.88 KB
Raw

viagogo API Documentation

CI

This is the documentation website for the viagogo API! (http://developer.viagogo.net)

This website is built using Docusaurus 2, a modern static website generator.

How to contribute

All submissions are welcome. Fork the repository, read the rest of this README file and make some changes. Once you're done with your changes send a pull request. Thanks!

How to run the site locally

Prerequisites

You're going to need:

Getting Set Up

  1. Fork this repository on Github.
  2. Clone your forked repository (not our original one) to your hard drive with git clone https://github.com/YOURUSERNAME/viagogo-api-docs.git
  3. cd viagogo-api-docs
  4. Install all dependencies: npm install
  5. Start the preview server: npm run start

How to edit the documentation

Project Structure

This website is built using Docusaurus 2 and it uses the default project structure for Docusaurus websites.

Editing Existing Docs and Announcements

Open the .md or .mdx file for the content you want to edit and make your changes. See Docusaurus Markdown Features for more information.

Adding New Docs

  1. Add a .md or .mdx file under the ./docs/ folder
  2. Update ./sidebars.js to add your new doc to the side-bar. See Docusaurus Sidebar for more details

Adding New Announcements

  1. Add a new .md or .mdx file named YYYY-MM-DD-your-announcement-name.mdx under the ./blog/ folder. See Docusaurus Blogs for more details