# jx-docs

**Repository Path**: linuxsuren/jx-docs

## Basic Information

- **Project Name**: jx-docs
- **Description**: the source code used to build the documentation and website for Jenkins X
- **Primary Language**: HTML
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2018-04-28
- **Last Updated**: 2024-05-30

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Jenkins X Docs

Documentation site for [Jenkins X](http://jenkins-x.io/)

**Please browse these docs** on the [http://jenkins-x.io/](http://jenkins-x.io/) site as the links don't all work when browsing the markdown files inside github 


## Build the docs locally

To edit the docs locally and try out what the [website](http://jenkins-x.io/) will look like then you need to clone this repository:

```bash
$ git clone https://github.com/jenkins-x/jx-docs.git
```

Then to view the docs in your browser, [install Hugo](https://gohugo.io/). Navigate to the directory, run hugo server, and open up the link:

```bash
$ cd jx-docs
$ hugo server

Started building sites ...
.
.
Serving pages from memory
Web Server is available at http://localhost:1313/ (bind address 127.0.0.1)
Press Ctrl+C to stop
```