README.md 1.61 KB
Newer Older
Manuel Tancoigne's avatar
Manuel Tancoigne committed
1
# Typing Monkey
Manuel Tancoigne's avatar
init  
Manuel Tancoigne committed
2

Manuel Tancoigne's avatar
Manuel Tancoigne committed
3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58
> A collection of templates for annoying documents.

Online: https://typing-monkey.com

News: https://experimentslabs.com/projects/typing-monkey

## Contribute

### Code

Fork. Code. Commit. Merge request.

You're welcome !

### Writing templates

For now, there is now online interface to create and update a template,
you have to fork this project and make merge requests.

Templates are markdown files processed and rendered in both Markdown and
HTML.

The documentation about formatting your template, create dynamic blocks 
and use variables is available [online](https://typing-monkey.com/#/help).

To create a template, create a file somewhere in `public/templates` and 
add an entry in `src/templates.json`. You may specify a license, a 
language and some tags.

### Translations

If you want to see the project translated in your language, let's say,
Esperanto, create `src/locales/eo.json` and put the translation strings
in it. Use another translation file as a base.

Edit all the translation files and add your locale in the `locale section`:

```json
  "locales": {
    "en": "English",
    "eo": "Esperanto",
    "fr": "Français"
  },
```

To finish, add the entry in the menu: edit `src/components/LocaleSelector.vue`
and add `eo` to the list of supported locales:

```js
  data () {
    return {
      locales: ['en', 'eo', 'fr'],
    }
  },
```

Manuel Tancoigne's avatar
init  
Manuel Tancoigne committed
59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82
## Project setup
```
yarn install
```

### Compiles and hot-reloads for development
```
yarn run serve
```

### Compiles and minifies for production
```
yarn run build
```

### Run your tests
```
yarn run test
```

### Lints and fixes files
```
yarn run lint
```