https://github.com/reyesoft/dev-docs-base

Skeleton and dependencies for dev sites using documentor
https://github.com/reyesoft/dev-docs-base

Last synced: 7 days ago
JSON representation

Skeleton and dependencies for dev sites using documentor

• Host: GitHub
• URL: https://github.com/reyesoft/dev-docs-base
• Owner: reyesoft
• Created: 2019-11-13T17:22:25.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2022-10-06T08:11:36.000Z (over 2 years ago)
• Last Synced: 2024-11-09T12:36:15.569Z (2 months ago)
• Language: CSS
• Size: 5.21 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Dev Docs Base documentation

## Installation

```bash

sudo apt-get install ruby ruby-dev make gcc build-essential

sudo gem install jekyll bundler

bundle install

bundle exec jekyll serve

```

## Publish to Github Pages

If you want to publish form master branch:

```bash

bundle exec jgd

```

If you want to publish from other branch:

```bash

bundle exec jgd -r BRANCH_NAME

```

## Quickstart

Copy or rename *\_config.copy.yml* file to *\_config.yml* and fill the required fields:

- title

- version

- email

- description

- baseurl

- url

- appurl

- apiurl

- api_name

- git_address

- git_edit_address

- logo_url

- tip_image

- styleguide_img_url

You can add an image with the name `bg.jpg` in the `img` folder to be used as header background.

## Documented resources structure

Documented resources must define the following fields in the YAML Front Matter:

``` yaml

version: API version

resource: resource type

permalink: /docs/{API version}/resources/{resource type}/

section: Parent section name

partOf: parent resource

attributes:

  -

    name: attribute name

    crud: attribute crud

    filter: supported filter (optional)

    required: if the atribute is required (optional, defaults to false)

    value_type: supported content type (optional, defaults to string)

```