Skip to content

Latest commit

 

History

History
24 lines (16 loc) · 1 KB

File metadata and controls

24 lines (16 loc) · 1 KB

Textwire Documentation

Project Overview

VitePress documentation site for Textwire templating engine for Go programming language.

Directory Structure

  • Theme files: docs/.vitepress/theme/
  • Syntax highlighting: docs/.vitepress/textwire.tmLanguage.json
  • VitePress config: docs/.vitepress/config.mts
  • Versioned docs: docs/versions/
  • Blog articles: docs/.vitepress/blog/
  • Blog registry: docs/.vitepress/theme/modules/blogPosts.ts

Development

  • No tests needed
  • Build: npm run build

Important

  • If you write inline code examples with {{ and }} braces that Textwire uses, wrap them in HTML tags instead. Intead of {{ x = 5}} Textwire example, you should write {{ x = 5 }}. It's because if you write it with backtics, Vue will execute them since {{ }} braces are also used in Vue.js.
  • For all other inline code, use backticks code. Only use code when the code contains {{ or }} braces to prevent Vue.js from executing it.