@specfy/sync
v1.0.10
Published
[![Main](https://github.com/specfy/sync/actions/workflows/ci.yaml/badge.svg)](https://github.com/specfy/sync/actions/workflows/ci.yaml) [![codecov](https://codecov.io/gh/specfy/sync/branch/main/graph/badge.svg?token=GQ2KKSUZTF)](https://codecov.io/gh/spec
Downloads
13
Readme
Sync
Automatically analyze stack and deploy documentation to Specfy, on every push to main.
Usage
# Installation (optional)
npm install -g @specfy/sync
# Create required .specfyrc.json
npx specfy-sync init
# Manual upload
npx specfy-sync run [--dry-run] [--help] [...]
Github Action
name: Main
on:
push:
branches: [ main ]
jobs:
ci:
steps:
- name: Upload to Specfy
uses: specfy/sync@1
with:
token: ${{ secrets.SPECFY_TOKEN }}
How it works?
Documentation
The process is very straight forward. It takes all .md
files it can find in the specified folder and upload them to the Specfy's backend.
Some files and folders are excluded from auto discovery, if you have trouble with missing files, please open an issue.
Stack
Stack is analysed using @specfy/stack-analyser. The raw output is processed on Specfy's backend.