Git Product home page Git Product logo

docs's Introduction

Documentation for Amphitheatre

This website is built with Zola. Content includes all Amphitheatre usage guides, desktop and terminal command line manuals, as well as API interface definitions and other documentation, written using CommonMark, a well-defined and highly compatible Markdown specification. Pull requests welcome!

Website Netlify License GitHub contributors GitHub issues

Developing

$ zola serve # dev server at http://127.0.0.1:1111

This will build and serve the site using a local server. Before starting, Zola will delete the output directory (by default public in project root) to start from a clean slate.

The serve command will watch all your content and provide live reload without a hard refresh if possible. If you are using WSL2 on Windows, make sure to store the website on the WSL file system.

Some changes cannot be handled automatically and thus live reload may not always work. If you fail to see your change or get an error, try restarting zola serve.

Deploying

The site is automatically deployed when commits land in master, via Netlify.

If you are the maintainer of a community translation fork and would like to deploy via Netlify instead of GitHub pages, please ping @wangeguo in an issue to request a Netlify team membership and DNS update.

Want to help with the translation?

If you feel okay with translating quite alone, you can fork the repo, post a comment on the Community Translation Announcements issue page to inform others that you're doing the translation and go for it.

Credits

Heavily inspired by

docs's People

Contributors

wangeguo avatar lispking avatar dongowu avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.