whdalsrnt / docs

Documentation Site

Cloudforet Document

How to use this repository

Prerequisities

You need following installed locally

• npm
• Go
• Hugo(Extended version)
• Docker & Docker Compose

Before we start, install the dependencies, Clone the repository and navigate to the directory.

git clone --recurse-submodules --depth 1 https://github.com/[username]/docs

cd docs

Cloudforet blog uses Docsy Hugo theme. So, we strongly recommend pulling in the submodule and other developmment dependencies by running the following.

# pull in the Docsy submodule
git submodule update --init --recursive --depth 1

Install PostCSS

To build Cloudforet blog, you also need PostCSS to create the final asset. If you need install it, you must have recent version of NodeJS installed on your machine so you can use npm.

npm install --no-optional -D --save

Running Blog locally

Set MacOS max file limit

You should set maxfiles limitation; docsy issue

sudo launchctl limit maxfiles 65535 200000
ulimit -n 65535
sudo sysctl -w kern.maxfiles=200000
sudo sysctl -w kern.maxfilesperproc=65535

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

hugo server -D

Running Docker container locally

You can run Cloudforet blog by inside a Docker container.

docker-compose up --build

Open you web browser type http://localhost:1313 in your navigation bar.

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

To remove the produced images run:

docker-compose rm