Giter VIP home page Giter VIP logo

docs-template's Introduction

Build Template End 2 End Testing Vale

docs-template

Template repository for Wirecard documentation platforms with wirecard/docs-toolchain.

Setup

bundle config --local path vendor/bundle
bundle install --jobs 4 --retry 3
bundle exec rake -T                      # see available rake tasks

How to use

The content/ directory contains all the asciidoctor files and an index.adoc file, which is the central file. All other files will be included in this index.adoc. To build the content, another repository (wirecard/docs-toolchain) is used. This repository contains the toolchain for this template. In order to use the toolchain, use the button Use this template at the top, this will create a fork of this template which you can customize.

Customize

This template contains several built-in solutions, tests and styles which can be customized. Refer to the wiki to find out about the ways you can customize this template.

Vale

This repository supports Vale to check the writing. To run Vale, do:

bash .scripts/get_vale_styles.sh # run ONCE
vale content/

End2End Tests

For frontend testing using Selenium, see end2end/README.md.

docs-template's People

Contributors

comanl avatar hmknapp avatar lagerfeuer avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

Forkers

muhammedtech

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.