https://mongodb-university.github.io/Bluehawk/

A markup language and tool for extracting code examples, checkpointing tutorials, and dynamically transforming text
https://mongodb-university.github.io/Bluehawk/

docs docs-as-code tools tutorial-code

Last synced: 24 days ago
JSON representation

A markup language and tool for extracting code examples, checkpointing tutorials, and dynamically transforming text

• Host: GitHub
• URL: https://mongodb-university.github.io/Bluehawk/
• Owner: mongodb-university
• License: other
• Created: 2020-09-21T16:45:34.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2024-10-18T17:37:34.000Z (about 2 months ago)
• Last Synced: 2024-11-17T05:31:41.818Z (25 days ago)
• Topics: docs, docs-as-code, tools, tutorial-code
• Language: TypeScript
• Homepage: https://mongodb-university.github.io/Bluehawk/
• Size: 8.32 MB
• Stars: 29
• Watchers: 8
• Forks: 17
• Open Issues: 19
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.txt

Awesome Lists containing this project

• awesome-docs - Bluehawk

README

        
# Bluehawk

[![npm version](https://badge.fury.io/js/bluehawk.svg)](https://badge.fury.io/js/bluehawk)

Bluehawk is a markup processor for extracting and manipulating arbitrary code.

With Bluehawk, you can:

- Extract code examples for use in documentation

- Generate formatted code examples for use in documentation

- Replace "finished" code with "todo" code for a branch in a tutorial repo

> 💡 See our [Documentation](https://mongodb-university.github.io/Bluehawk/) or

> [open an issue](https://github.com/mongodb-university/Bluehawk/issues/new)