Skip to content

Commit 0278663

Browse files
docs: left-justify prerequisite tables
1 parent 0bad1a5 commit 0278663

14 files changed

+316
-85
lines changed

README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,37 @@ To disable colored output, use the `--no-color` flag:
117117
metaschema-cli --no-color <command>
118118
```
119119

120+
#### Shell Completion
121+
122+
The CLI supports tab completion for Bash and Zsh shells, providing intelligent suggestions for commands, subcommands, and options.
123+
124+
**Bash:**
125+
126+
```bash
127+
# Generate and source completion (temporary, current session only)
128+
source <(metaschema-cli shell-completion bash)
129+
130+
# Or save to a file and source it in your ~/.bashrc for persistence
131+
metaschema-cli shell-completion bash --to ~/.metaschema-completion.bash
132+
echo 'source ~/.metaschema-completion.bash' >> ~/.bashrc
133+
```
134+
135+
**Zsh:**
136+
137+
```zsh
138+
# Ensure your completions directory exists
139+
mkdir -p ~/.zsh/completions
140+
141+
# Generate completion script
142+
metaschema-cli shell-completion zsh > ~/.zsh/completions/_metaschema-cli
143+
144+
# Add to your ~/.zshrc if not already configured
145+
echo 'fpath=(~/.zsh/completions $fpath)' >> ~/.zshrc
146+
echo 'autoload -Uz compinit && compinit' >> ~/.zshrc
147+
```
148+
149+
After setting up completion, restart your shell or source the configuration file.
150+
120151
## Relationship to prior work
121152

122153
The contents of this repository is based on work from the [Metaschema Java repository](https://github.com/usnistgov/metaschema-java/) maintained by the National Institute of Standards and Technology (NIST), the [contents of which have been dedicated in the worldwide public domain](https://github.com/usnistgov/metaschema-java/blob/1a496e4bcf905add6b00a77a762ed3cc31bf77e6/LICENSE.md) using the [CC0 1.0 Universal](https://creativecommons.org/publicdomain/zero/1.0/) public domain dedication. This repository builds on this prior work, maintaining the [CCO license](https://github.com/metaschema-framework/metaschema-java/blob/main/LICENSE.md) on any new works in this repository.

src/site/markdown/building.md.vm

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ This guide explains how to build the Metaschema Java project from source code.
55
## Prerequisites
66

77
| Requirement | Minimum Version | Notes |
8-
|-------------|-----------------|-------|
8+
|:------------|:----------------|:------|
99
| Java JDK | 17 | Required for building (output JARs are JDK 11 compatible) |
1010
| Maven | 3.9.0 | Required for building |
1111
| Git | 2.0 | Required for cloning |
@@ -146,6 +146,16 @@ export MAVEN_OPTS="-Xmx2g"
146146
mvn install
147147
```
148148

149+
## Building the Site
150+
151+
To build the project documentation site:
152+
153+
```bash
154+
mvn site
155+
```
156+
157+
The generated site appears in `target/site/`. For multi-module builds, each module's site is in its respective `target/site/` directory.
158+
149159
## Contributing
150160

151161
For contribution guidelines, including code style requirements and the pull request process, see [CONTRIBUTING.md](${project.scm.url}/blob/develop/CONTRIBUTING.md).

src/site/markdown/claude-integration.md.vm

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Claude Code plugins provide specialized skills for:
1414
## Prerequisites
1515

1616
1. [Install Claude Code](https://docs.anthropic.com/en/docs/claude-code)
17-
2. Ensure the Metaschema plugins are available in your configuration
17+
2. Install the [Metaschema plugins](https://github.com/metaschema-framework/claude-plugins/tree/main)
1818

1919
## Available Plugins
2020

@@ -23,7 +23,7 @@ Claude Code plugins provide specialized skills for:
2323
Skills for working with Metaschema definitions:
2424

2525
| Skill | Description |
26-
|-------|-------------|
26+
|:------|:------------|
2727
| `metaschema:metaschema-basics` | Introduction to Metaschema concepts |
2828
| `metaschema:metaschema-module-authoring` | Creating and modifying modules |
2929
| `metaschema:metaschema-constraints-authoring` | Defining validation constraints |
@@ -34,15 +34,15 @@ Skills for working with Metaschema definitions:
3434
Skills for working with OSCAL documents:
3535

3636
| Skill | Description |
37-
|-------|-------------|
37+
|:------|:------------|
3838
| `oscal:oscal-basics` | OSCAL document types and structure |
3939

4040
### Tool Plugins
4141

4242
Skills for using CLI and library tools:
4343

4444
| Skill | Description |
45-
|-------|-------------|
45+
|:------|:------------|
4646
| `oscal-tools:using-oscal-cli` | Running oscal-cli commands |
4747
| `metaschema-tools:using-metaschema-java` | Using the Metaschema Java library |
4848

@@ -51,7 +51,7 @@ Skills for using CLI and library tools:
5151
For contributors to the Metaschema framework:
5252

5353
| Skill | Description |
54-
|-------|-------------|
54+
|:------|:------------|
5555
| `dev-metaschema:development-workflow` | TDD, debugging, testing patterns |
5656
| `dev-metaschema:repo-organization` | Project structure and relationships |
5757
| `dev-metaschema:unit-test-writing` | Writing comprehensive tests |
@@ -105,6 +105,8 @@ When working with the Metaschema Java library, Claude can help you:
105105

106106
## Learn More
107107

108+
For more information about Claude Code and the technologies used in this project:
109+
108110
- [Claude Code Documentation](https://docs.anthropic.com/en/docs/claude-code)
109111
- [Metaschema Specification](https://pages.nist.gov/metaschema/specification/)
110112
- [Metapath Reference](https://pages.nist.gov/metaschema/specification/metapath/)

0 commit comments

Comments
 (0)