Skip to content

Update documentation and generics - #12

Merged
mario-deluna merged 7 commits into
masterfrom
develop
Jul 16, 2026
Merged

Update documentation and generics#12
mario-deluna merged 7 commits into
masterfrom
develop

Conversation

@mario-deluna

Copy link
Copy Markdown
Member

This pull request sets up VitePress-based documentation for the project, including a custom syntax highlighter and PHPDoc integration, and updates all documentation links to the new GitHub Pages site. The most important changes are grouped below:

Documentation Site Setup:

  • Adds a new GitHub Actions workflow (.github/workflows/docs.yml) to build and deploy documentation to GitHub Pages on every push to master.
  • Introduces a VitePress configuration (docs/.vitepress/config.js) with a custom theme, sidebar, and navigation tailored for the project, and sets the base path for GitHub Pages.

Syntax Highlighting and PHPDoc Integration:

  • Adds a committed TextMate grammar (docs/.vitepress/ctn.tmLanguage.js) for .ctn files, ensuring consistent syntax highlighting in both the docs and VSCode extension.
  • Implements a custom VitePress markdown-it plugin (docs/.vitepress/phpdoc.js) to parse [~ PHPDoc](/src/File.php#method) directives and render tabbed method documentation blocks by extracting PHP signatures and docblocks at build time.

Documentation Link Updates:

  • Updates all links in README.md to point to the new GitHub Pages documentation at https://clancats.github.io/Container/ instead of the old clancats.io site, and fixes minor formatting issues. [1] [2] [3] [4]

@mario-deluna
mario-deluna merged commit fedb46d into master Jul 16, 2026
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant