An open API service indexing awesome lists of open source software.

https://github.com/updatecli/website

Updatecli website
https://github.com/updatecli/website

hacktoberfest

Last synced: 7 months ago
JSON representation

Updatecli website

Awesome Lists containing this project

README

          

# README

[![Netlify Status](https://api.netlify.com/api/v1/badges/5aa3d179-6a7a-41c4-8f31-b201badf0a39/deploy-status)](https://app.netlify.com/sites/amazing-golick-2d0138/deploys)

## Requirements

Install all dependencies:

- [Hugo](https://gohugo.io/getting-started/installing/) >= 0.75.0/extended (needed for SCSS processing support)
- [Node.js](https://nodejs.org/) >= 14.15.0 (needed to install npm packages and run commands)
- [Asciidoctor](https://asciidoctor.org/) >= 2.0.16 (needed to render the .adoc files with Hugo)

## Get started

Have your local site in two steps:

### Install npm packages

```bash
npm install
```

### Start local development server

```bash
npm run start
```

### 3. Open the start page of the website

Point your browser to `http://localhost:1313`

### 4. Stopping the local development server

Execute `` from the session where `npm run start` is running.

## Other commands

Doks comes with [commands](https://getdoks.org/docs/prologue/commands/) for common tasks.

## Contributing

### Asciinema shortcode

To add a asciinema video, you can use the shortcode `{{}}`

## Documentation

- [Netlify](https://docs.netlify.com/)
- [Hugo](https://gohugo.io/documentation/)
- [Doks](https://getdoks.org/)