https://github.com/SmartBear/cucumberstudio-api-documentation

Beautiful static documentation for your API
https://github.com/SmartBear/cucumberstudio-api-documentation

Last synced: 3 days ago
JSON representation

Beautiful static documentation for your API

• Host: GitHub
• URL: https://github.com/SmartBear/cucumberstudio-api-documentation
• Owner: SmartBear
• License: apache-2.0
• Fork: true (ringcentral/slate)
• Created: 2017-01-19T08:09:28.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2023-08-26T05:03:32.000Z (about 1 year ago)
• Last Synced: 2024-08-03T23:24:05.448Z (3 months ago)
• Language: SCSS
• Homepage:
• Size: 2.67 MB
• Stars: 2
• Watchers: 7
• Forks: 1
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# CucumberStudio API documentation (https://smartbear.github.io/cucumberstudio-api-documentation/)

The API documentation is written using Slate [https://github.com/lord/slate]

To edit it, clone this repository.

```bash

cd cucumberstudio-api-documentation

bundle install

bundle exec middleman server

== The Middleman is loading

== View your site at "http://localhost:4567", "http://127.0.0.1:4567"

== Inspect your site configuration at "http://localhost:4567/__middleman", "http://127.0.0.1:4567/__middleman"

```

Edit the pages in the source directory using the markdown syntax. To deploy,

simply use the `deploy.sh` script:

```bash

./deploy.sh

   identical  build/stylesheets/print.css

   identical  build/stylesheets/screen.css

   identical  build/images/navbar.png

   identical  build/images/cucumberstudio-logo.png

   identical  build/images/getting-started/doc-api-cred-02.png

   identical  build/images/getting-started/doc-api-cred-01.png

   identical  build/images/getting-started/doc-api-project-id.png

   identical  build/images/logo.png

   identical  build/fonts/slate.woff

   identical  build/fonts/slate.woff2

   identical  build/fonts/slate.eot

   identical  build/fonts/slate.ttf

   identical  build/fonts/slate.svg

   identical  build/javascripts/all_nosearch.js

   identical  build/index.html

   identical  build/javascripts/all.js

Project built successfully.

cd8e7906a9b6e51931a13fc13b8158b8fcae45d3	refs/heads/gh-pages

Depuis github.com:Smartbear/cucumberstudio-api-doc

   0f6ce0e..cd8e790  gh-pages   -> gh-pages

[gh-pages f539285] publish: :memo: Add some doc about features endpoints

 1 file changed, 143 insertions(+)

```