https://github.com/specmatic/docs.specmatic.io
The specmatic documentation website
https://github.com/specmatic/docs.specmatic.io
cdd contract-driven-development contract-testing specmatic
Last synced: 4 months ago
JSON representation
The specmatic documentation website
- Host: GitHub
- URL: https://github.com/specmatic/docs.specmatic.io
- Owner: specmatic
- Created: 2025-04-11T16:21:52.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-06-23T08:52:53.000Z (10 months ago)
- Last Synced: 2025-06-23T09:43:39.923Z (10 months ago)
- Topics: cdd, contract-driven-development, contract-testing, specmatic
- Language: Ruby
- Homepage: http://docs.specmatic.io/
- Size: 32.2 MB
- Stars: 0
- Watchers: 6
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Security: security-disclosure.md
Awesome Lists containing this project
README
# Specmatic Documentation
Documentation for [Specmatic](//specmatic.in)
Dev Setup
* Install Ruby > 2.7 - Preferably with rbenv
* Run ```bundle``` to install dependencies
* Run ```bundle exec jekyll serve``` to start server on localhost:4000
Dev Containers (Recommended Approach)
* Pre-requisites - Docker Desktop
* Visual Studio Code 3
* Open Project in VSCode
* VSCode will ask you install necessary extensions and open in dev container. If not install "Visual Studio Code Remote - Containers" - https://code.visualstudio.com/docs/remote/containers
* The Terminal inside VSCode is mapped to Docker Container. Run below commands in that terminal.
* ```bundle``` to install dependencies
* ```bundle exec jekyll serve``` to start server
* Click on the "localhost:4000" link in terminal to launch it in browser at the ephemeral port
* On my machine it is forwarded to localhost:4001
* You can even push to GitHub inside this terminal because Dockerfile maps your keys
Reference - How to DevContainers for the first time for Jekyll Projects
* Cmd + Shift + P and run ```Remote-Containers: Add Development Container Configuration Files...```
* Search for Jekyll and Choose bullseye
* This will add the .devcontainers folder with necessary configs, re-open project in container