https://github.com/wailsapp/docsv1

Docs for the V1 release
https://github.com/wailsapp/docsv1

Last synced: about 2 months ago
JSON representation

Docs for the V1 release

• Host: GitHub
• URL: https://github.com/wailsapp/docsv1
• Owner: wailsapp
• License: mit
• Created: 2019-08-27T22:22:45.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2022-08-27T16:24:36.000Z (over 2 years ago)
• Last Synced: 2023-03-27T11:01:42.719Z (almost 2 years ago)
• Language: JavaScript
• Homepage: https://wails.app
• Size: 48.1 MB
• Stars: 17
• Watchers: 2
• Forks: 39
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# docsv1

[WIP] Docs for the V1 release

## DEV TEST/BUILD

The documentation site is built using the [Hugo](https://gohugo.io/) static site generation tool. To test, preview or get a real feel for the site, you will need to build the site from this repository.

This short document assumes that you are familiar with `git` and the associated shell tools for your platform. Please note that the initial example commands are based on Linux (but should work on a Mac). I would encourage those who have access to these systems to add the appropriate command samples to this document.

* First install Hugo by following the docs on the [Hugo site](https://gohugo.io/getting-started/installing#readout).

* Clone this repository to the desired location on your local system with something like `cd /path/to/clone/repo && git clone https://github.com/wailsapp/docsv1.git`.

* Change to the cloned repository with `cd docsv1`.

* Run the `hugo` command that runs the dev server with `hugo server`.

* The resulting command will display a localhost address (i.e. http://localhost:1313/) of which you can open in your local web browser (to preview the site).

 

### Condensed Command Sample

```

cd /path/to/clone/repo

git clone https://github.com/wailsapp/docsv1.git

cd docsv1

hugo server

```