Akash documentation

Folder Structure

Running the website locally

Building and running the site locally requires a recent extended version of Hugo.

Once you've made your working copy of the site repo, from the repo root folder, run:

hugo server

Running a container locally

You can run akash-docs inside a Docker container, the container runs with a volume bound to the akash-docs folder. This approach doesn't require you to install any dependencies other than Docker Desktop on Windows and Mac, and Docker Compose on Linux.

1. Build the docker image

   docker-compose build

2. Run the built image

   docker-compose up

   NOTE: You can run both commands at once with docker-compose up --build.

3. Verify that the service is working.

   Open your web browser and type http://localhost:1313 in your navigation bar, This opens a local instance of the akash-docs homepage. You can now make changes to the akash-docs and those changes will immediately show up in your browser after you save.

Cleanup

To stop Docker Compose, on your terminal window, press Ctrl + C.

To remove the produced images run:

docker-compose rm

For more information see the Docker Compose documentation.

Troubleshooting

As you run the website locally, you may run into the following error:

➜ hugo server

INFO 2021/01/21 21:07:55 Using config file: 
Building sites … INFO 2021/01/21 21:07:55 syncing static files to /
Built in 288 ms
Error: Error building site: TOCSS: failed to transform "scss/main.scss" (text/x-scss): resource "scss/scss/main.scss_9fadf33d895a46083cdd64396b57ef68" not found in file cache

This error occurs if you have not installed the extended version of Hugo.

Or you may encounter the following error:

➜ hugo server

Error: failed to download modules: binary with name "go" not found

This error occurs if you have not installed the go programming language on your system.