pixotope-documentalist 1.2.0 → 1.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +0 -29
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -162,7 +162,6 @@ npx pixotope-documentalist diff --config ./config.yml --target master
|
|
|
162
162
|
|----------|---------|
|
|
163
163
|
| `CONFLUENCE_USER` | Confluence account email |
|
|
164
164
|
| `CONFLUENCE_TOKEN` | Confluence API token ([generate here](https://id.atlassian.com/manage-profile/security/api-tokens)) |
|
|
165
|
-
| `PIXOTOPE_DOCS_NPM_TOKEN` | npm publish auth token (only for publishing the package) |
|
|
166
165
|
|
|
167
166
|
Create a `.env` file (git-ignored) for local use:
|
|
168
167
|
|
|
@@ -171,34 +170,6 @@ CONFLUENCE_USER=your.email@pixotope.com
|
|
|
171
170
|
CONFLUENCE_TOKEN=your_api_token
|
|
172
171
|
```
|
|
173
172
|
|
|
174
|
-
## Development
|
|
175
|
-
|
|
176
|
-
```bash
|
|
177
|
-
# Install dependencies
|
|
178
|
-
npm install
|
|
179
|
-
|
|
180
|
-
# Run locally with ts-node
|
|
181
|
-
npx ts-node src/index.ts preview --config example/config.yml
|
|
182
|
-
|
|
183
|
-
# Run tests
|
|
184
|
-
npm test
|
|
185
|
-
|
|
186
|
-
# Build
|
|
187
|
-
npm run build
|
|
188
|
-
|
|
189
|
-
# Publish to npm
|
|
190
|
-
npm publish
|
|
191
|
-
```
|
|
192
|
-
|
|
193
|
-
## Example
|
|
194
|
-
|
|
195
|
-
The `example/` folder contains a self-contained demo:
|
|
196
|
-
|
|
197
|
-
```bash
|
|
198
|
-
npx ts-node src/index.ts preview --config example/config.yml
|
|
199
|
-
# Check output in example/output/formatted/
|
|
200
|
-
```
|
|
201
|
-
|
|
202
173
|
## Supported File Types
|
|
203
174
|
|
|
204
175
|
- `.ts`, `.tsx` (TypeScript)
|
package/package.json
CHANGED