github.com/cs3org/reva/v2@v2.27.7/docs/README.md (about)

     1  # Reva Documentation
     2  
     3  This documentation is available at: [https://reva.link](https://reva.link)
     4  
     5  ## Build locally
     6  
     7  Before hacking you need to install [Hugo extended version](https://github.com/gohugoio/hugo/releases) and
     8  run `npm install postcss-cli` only if you plan to hack on the theme style.
     9  
    10  ```
    11  git clone https://github.com/cs3org/reva
    12  cd reva
    13  git submodule update --init --recursive # to install the theme and deps
    14  cd docs
    15  hugo server
    16  ```
    17  
    18  Open a browser at http://localhost:1313
    19  
    20  ## Theme
    21  The documentation is based on the [Docsy](https://github.com/google/docsy) theme for technical documentation sites, providing easy site navigation, structure, and more. 
    22  In the [Docsy User Guide](https://www.docsy.dev/docs/getting-started/) to get started.
    23  
    24  
    25  ## Continuous Deployment
    26  If you don't want to build locally, once you create a Pull Request to the repo, a Continuous Integration
    27  step will take care of deploying your changes to Netlify for previewing your changes to the documentation.