INCATools / INCATools/ontology-development-kit

Add Markdown formatting at end of ODK seed command

Open
#1,371 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
Dockerfile
Stars
375
Forks
69
Avg merge
3d 5h
Merged PRs (30d)
7

Description

It would make it much easier to get up and running with ODK if the Markdown that it produced were nicely formatted.

- [ ] Add `npx --yes prettier --check --prose-wrap always --write '**/*.md'` to seed workflow
- [ ] Add proper code highlighting wherever possible
- [ ] Add the option to include a markdown linting GHA test

Contributor guide

Open the contributing guide

Research direction

Start at the ODK seed workflow and inspect the Markdown files it produces. Run the listed Prettier command to establish the current formatting, then check how code blocks are represented and how GitHub Actions tests are configured. Done means the seed output is formatted, code highlighting is added where possible, and a Markdown linting workflow option is included.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions, markdown
Domain
ci-cd, documentation
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
66/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.