Skip to content

maayanf24/submariner-website

 
 

Repository files navigation

title date weight
Contributing to the Website
2020-02-19 22:03:26 +0100
60

The Submariner documentation website is based on Hugo, Grav, Hugo-theme-learn, and is written in Markdown format.

You can always click the Edit this page link at the top right of each page, but if you want to test your changes locally before submitting you can:

  1. Fork the submariner-io/submariner-website on GitHub.

  2. Check out your copy locally:

    git clone ssh://git@github.com/<your-user>/submariner-website.git
    cd submariner-website
    make server
  3. An instance of the website is now running locally on your machine and is accessible at http://localhost:1313.

  4. Edit files in src. The browser should automatically reload so you can test your changes.

  5. Eventually commit, push, and pull-request your changes. You can find a good guide about the GitHub workflow here.

About

This is the submariner website source code (hugo based).

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages

  • CSS 49.6%
  • HTML 28.7%
  • JavaScript 21.1%
  • Other 0.6%