Giter Club home page Giter Club logo

docs's Introduction

SpaceONE 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/spaceone-dev/docs

cd docs

SpaceONE 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 SpaceONE 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

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 SpaceONE 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

docs's People

Contributors

jeoungseungho avatar song2kim avatar gikang82 avatar kanggeonu avatar claudia825 avatar dayoonkim avatar jean1042 avatar jihyungsong 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.