sap-archive / docpad-skeleton-apidocs Goto Github PK

View Code? Open in Web Editor NEW

5.0 9.0 17.0 56.96 MB

API documentation template for DocPad. Demo:

Home Page: http://yaas.github.io/chewie-sample-result

License: Apache License 2.0

JavaScript 77.98% CoffeeScript 0.48% HTML 0.40% CSS 21.09% Shell 0.02% Dockerfile 0.02%

docpad-skeleton-apidocs's Introduction

Important Notice

We have decided to stop the maintenance of this public GitHub repository.

Quick try out in terminal

Run this command in the terminal: git clone https://github.com/YaaS/docpad-skeleton-apidocs.git
Open the cloned project: cd docpad-skeleton-apidocs
Call the following commands:

npm run prepare
npm run init -> to load the currently-integrated sample data
npm run start

Open this page: http://localhost:9778/

Quick try out with Docker

Start the container in the terminal: docker run -it --rm --name api-doc-sample -p 9778:9778 derberg/dsa-quickstart /bin/bash
Start the documentation portal with sample data in it: npm run start
Open this page: http://localhost:9778/

Using locally

If you called npm run prepare at least once, it means all the dependencies you need are installed. Now you can just start generation and the server with the following command: npm run start.

Production

To trigger generation with production configuration:

Call the following commands: npm run init and npm run prepare-deploy
Notice the new out folder. This folder contains all generated files and you can use them in production. For example, you can copy the contents of the out folder to your GitHub Pages repository.

To push generated documentation to your repository, run:

npm run preparePushResult && npm run pushResult

Tutorial

Start using this documentation template by following these tutorials:

Automate your documentation builds by following Set up documentation continuous delivery pipeline.

docpad-skeleton-apidocs's People

Contributors

Stargazers

Watchers

Forkers

irruka skabandari dobrinka-stefanova mjasinski5 mareknawa sabineberland gvtmrob nicolasphilippe ekaterina-mitova ilidima claudiscloud avyrsky przezor mmitoraj mindyjamiel jbcontreras isabella232

docpad-skeleton-apidocs's Issues

Support "Security" documents

Support "Security" documents for services

AC

on services left nav between Glossary and Tutorials, we should be able to add "Security". Now we are hardcoded for particular titles.
modify placeholder to accept new type of title

Configure TravisCI

AC:

After each PR, simple scenario should be run automatically
Scenario: prepare => init => compile => preparePushResults => pushResults (to GitHub pages)
Run it on few NodeJS versions: 4.2.1, 6.9.0

enable s3 support on chewieConfig

add configuration for s3 to enable s3 usage inside docker image

Update build.zip

Due to change link to build.zip we need update it in config

Wrong sample data reposiotry

Instead of docpad-skeleton-apidocs-sampledata use chewie-sample-data.

[Enable customization] General navigation

top nav configurable through some json/yaml that you can pass into the skeleton and define: what is the name of the navigation node and relative path

adding docu about build automation

Explain how to use TravisCI to automate building of the API Documentation site on GitHub pages

Push .nojekyll

Due to chewie update file .nojekyll has to be passed explicitly to preparePushResult

Use chewie from npm

Right now we clone it "as is" from Github master branch, move it to npm

Interactive tutorials on GH Pages not working

Interactive tutorials on GH Pages not working, urls in build dir are hardcoded to localhost

Fix metadata validator

On skeleton fail we want to know what is wrong and what file should we fix.
For example "Unable to parse." errors

GitHub pages are not working

there is a problem with src/raw/bower_components/list.js/docu file
temp fix, script:

"preparePushResult": "gulp preparePushResult && del-cli src/raw/bower_components/list.js/docs",

long term fix, proper cleanup of generated sources to not deploy not needed files