Docsy Action Website Template Repository

Overview

English | Tiếng Việt | Indonesia | 日本語 | 한국어

This repository contains a simple website template using Docsy. Docsy is a Hugo theme for technical documentation sets, providing simple navigation, site structure, and more. This template is a standard for creating other websites but with a focus on Issue templates and github workflows enabled for continuous deployment. Simply follow the instructions below depending on which enviroment you wish to use.

Building with Docker

The website and documentation is compiled and developed using Hugo and the Docsy Theme. To build the site requires Node, Npm, and PostCSS. Instead of having to locally install these tools, you can build the site using Docker. This has the advantage of providing a uniform development environment.

• Docker: To install docker, please refer to the documentation at https://docs.docker.com/get-docker/.

• Once you've made your working copy (see below) of the site repo, from the repo root folder, running the hugo serve container with docker:

  $ docker-compose up -d
  

Then visit http://localhost:1313 to view the documentation site

Building with a local development environment

The Website is built using Docsy which is a Hugo theme for technical documentation sets, providing simple navigation, site structure, and more.

Prerequisites

Building and running the site locally requires a recent extended version of Hugo. The following are basic prerequisites building this site:

• Install a recent release of the Hugo "extended" version (we recommend version 0.53 or later). If you install from the release page, make sure you download the _extended version which supports SCSS.

• Install PostCSS so that the site build can create the final CSS assets. You can install it locally by running the following commands from the root directory of your project:

  sudo npm install -D --save autoprefixer
  sudo npm install -D --save postcss-cli
  

• Once you've made your working copy (see below) of the site repo, from the repo root folder, run:

  hugo server
  

Cloning the Website

$ git clone --recurse-submodules --depth 1 https://github.com/my/example.git
$ cd my-example

The site is build on the Docsy theme as a submodule. To update the submodule run:

$ git submodule update --recursive
$ git pull --recurse-submodules

Publishing Your Site

GitHub provides free and fast static hosting over SSL for personal, organization, or project pages directly from a GitHub repository via its GitHub Pages service and automating development workflows and build with GitHub Actions.

When publishing your site its important to change your baseURL in your config.tomol under config/_default. Rename your baseURL with the value /YOUR_REPOSITORY.github.io for your user repository.

Navigate to your repositories setting and under the settings tab select pages. From there you will want to select the deployed website branch and click save.

Issue template Forums

Issues can be used to send feedback to the team for further development. In the config.tomol under congfig/_default you will see a parameters section named [params.ui.feedback] with the enabled true by default. Note that there are two conditions for each button: a link for no and a link for yes. You can change the link to specifically use custom templates or leave them at the default prompting the user to choose a forum from the issue templates.

Edit Website Documents

The documents are in the content/{en,vn,in,jp,ko} directories, select the desired section to edit or add, for content organization please refer to: https://gohugo.io/content-management/organization/.

Change Log

See CHANGELOG.md for notable changes and versions.

Acknowledgements

• Project Catalyst
• Cardano Foundation
• IOHK Project Catalyst Team
• Hugo
• Docsy

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

See also the list of contributors who participated in this project.

Thanks goes to these wonderful contributors (see emoji key):

This project follows the all-contributors specification. Contributions of any kind welcome!

License

The published source code in the repository is licensed under the Apache License 2.0 - see the LICENSE file for details.

The published content in the repositoryis licensed under the Creative Attribution-Non-Commercial-ShareAlike (CC BY-NC-SA) License v4.0.

You are free to Share (copy and redistribute) the material in any medium or format adapt, remix, transform, and build upon the material. You may not use the material for commercial purposes. If you remix, transform, or build upon the material, you must distribute your contributions under the same license as the original. No warranties are given. The license may not give you all of the permissions necessary for your intended use.