Merge pull request #12 from textwire/vitepress

Vitepress

Author: SerhiiCho

.dockerignore

@@ -1,7 +1,7 @@
 node_modules
 .git
+.github
 .gitignore
+.prettierrc
 *.md
 Dockerfile
-.github
-.prettierrc

.github/workflows/gh-pages.yml

@@ -24,4 +24,4 @@ jobs:
               uses: JamesIves/github-pages-deploy-action@v4
               with:
                   # The folder the action should deploy.
-                  folder: build
+                  folder: docs/.vitepress/dist

.gitignore

@@ -1,22 +1,10 @@
-# Dependencies
-/node_modules
-
-# Production
-/build
-
-# Generated files
-.docusaurus
-.cache-loader
-
-# Misc
+node_modules
+.temp
+.cache
+.vscode
 .DS_Store
-.env.local
-.env.development.local
-.env.test.local
-.env.production.local
-
-npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
-
+dist
+/docs/.vitepress/dist
+/docs/.vitepress/cache
+yarn.lock
 Session.vim

AGENTS.md

@@ -0,0 +1,19 @@
+# Textwire Documentation
+
+## Project Overview
+
+VitePress documentation site for Textwire.
+
+## 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`

Dockerfile

@@ -1,5 +1,7 @@
 FROM node:24-alpine
 
+RUN apk add --no-cache git
+
 WORKDIR /app
 
 COPY package*.json .
@@ -9,6 +11,6 @@ RUN npm install && \
 
 COPY . .
 
-EXPOSE 3000
+EXPOSE 5173
 
-CMD ["npm", "start"]
+CMD ["npm", "run", "dev"]

README.md

@@ -1,89 +1,105 @@
 # Textwire Documentation
-Docs build with [Docusaurus](https://docusaurus.io/).
 
-## Contribute
-### NPM Commands
-#### Install Dependencies
-```bash
-npm install
-```
+Documentation website for [Textwire](https://github.com/textwire/textwire) templating language for Go (Golang) written with [VitePress](https://vitepress.dev/)
 
-#### Watch File Changes
-```bash
-npm start
-```
+## Contribute
 
-Navigate to `http://localhost:3000` to see your documentation.
+### Build an Image
 
-### With Container Engine
-#### Build an Image
 To build an image, navigate to the root of the project and run this command.
 
-For Podman:
+With Podman:
+
 ```bash
 podman-compose build
 ```
 
-For Docker:
+With Docker:
+
 ```bash
 docker compose build
 ```
 
-#### Create `node_modules`
+### Create `node_modules`
+
 Run this command to install npm packages and generate a `node_modules` directory on your local machine.
 
-For Podman:
+With Podman:
+
 ```bash
 podman-compose run --rm app npm i
 ```
 
-For Docker:
+With Docker:
+
 ```bash
 docker compose run --rm app npm i
 ```
 
-#### Run the Container
+### Run the Container
+
 To run a container, navigate to the root of the project and run this command.
 
-For Podman:
+With Podman:
+
 ```bash
-podman-compose up -d
+podman-compose up
 ```
 
-For Docker:
+With Docker:
+
 ```bash
-docker compose up -d
+docker compose up
 ```
 
-You can visit `http://localhost:3000` to see your documentation. Your files will be auto-compiled to plain JavaScript as you change them.
+You can visit [localhost:3000](http://localhost:3000) to see your documentation.
+
+### Enter the Container
 
-#### Enter the Container
 To enter inside of the container, run this command.
 
-For Podman:
+With Podman:
+
 ```bash
-podman-compose exec app sh
+podman-compose app sh
 ```
 
-For Docker:
+With Docker:
+
 ```bash
-docker compose exec app sh
+docker compose app sh
 ```
 
 You'll be able to run NPM commands inside of the container.
 
-> [!TIP]
-> You don't need to run `npm start` because it's already running after you created a container.
+### Remove the Container
 
-#### Delete the Container
-After you are done working on a project, you can cleanup by stopping and removing all the running containers for this project.
+After you are done working on a project, you can cleanup by removing running containers.
+
+With Podman:
 
-For Podman:
 ```bash
 podman-compose down
 ```
 
-For Docker:
+With Docker:
+
 ```bash
 docker compose down
 ```
+
+## NPM Commands
+
+### Install Dependencies
+
+```bash
+npm i
+```
+
+### Watch File Changes
+
+```bash
+npm run dev
+```
+
+Navigate to [localhost:5173](http://localhost:5173) to see your documentation if you run this project locally. With container engines it's going to be [localhost:3000](http://localhost:3000).

babel.config.js

@@ -8,4 +8,4 @@ services:
         volumes:
             - .:/app:z
         ports:
-            - 3000:3000
+            - 3000:5173