Commit 63ca41e1 authored by Henk Verlinde's avatar Henk Verlinde
Browse files

docs: update content

parent 0377b0de

.github/workflows/node.js-ci.yml

+3 −3
Original line number Diff line number Diff line 
# This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node

# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions

# Test and build your Hyas project

# For more information see: https://henkverlinde.com/continuous-integration-workflow-for-your-hyas-project/



name: CI

name: Hyas CI



on:

  push:

.gitignore

+1 −2
Original line number Diff line number Diff line
@@ -2,4 +2,3 @@ functions 
node_modules

public

resources
 
 No newline at end of file
 
yarn-error.log
 
 No newline at end of file

README.md

+9 −7
Original line number Diff line number Diff line
@@ -32,32 +32,34 @@ Nine reasons why you should use Doks: 


Make sure all dependencies have been installed:



- [Hugo](https://gohugo.io/) >= 0.75.0/extended

- [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)



## Get started



Create a new Doks project:

Have your Doks site in three steps:



### 1. Create a new Doks project:



```bash

git clone https://github.com/h-enk/doks.git my-doks-site

```



Install npm packages:

### 2. Install npm packages:



```bash

npm install

```



Start local development server:

### 3. Start local development server:



```bash

npm run start

```



### Other commands

## Other commands



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

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



## Quick start
@@ -67,7 +69,7 @@ Get your Doks site in 1 min. 


## Example site



👉 [doks.netlify.app](https://doks.netlify.app/)

- [doks.netlify.app](https://doks.netlify.app/)



## Documentation

assets/js/app.js

+19 −0
Original line number Diff line number Diff line
@@ -148,3 +148,22 @@ Source: 
  }



}());



/* eslint-disable */

var clipboard = new ClipboardJS('.btn-clipboard');



clipboard.on('success', function(e) {

    /*

    console.info('Action:', e.action);

    console.info('Text:', e.text);

    console.info('Trigger:', e.trigger);

    */



    e.clearSelection();

});



clipboard.on('error', function(e) {

    console.error('Action:', e.action);

    console.error('Trigger:', e.trigger);

});

/* eslint-enable */

assets/scss/common/_dark.scss

+4 −0
Original line number Diff line number Diff line
@@ -279,3 +279,7 @@ body.dark .alert-primary { 
  background: $link-color-dark;

  color: $body-bg-dark;

}



body.dark .figure-caption {

  color: $body-color-dark;

}