microsoft/TypeAgent
Publicmirrored from https://github.com/microsoft/TypeAgentAvailable
docs/README.md
71lines · modecode
| 1 | # TypeAgent Documentation |
| 2 | |
| 3 | This directory contains the documentation site for TypeAgent. |
| 4 | |
| 5 | ## Development |
| 6 | |
| 7 | ### Prerequisites |
| 8 | |
| 9 | - Node.js (v14 or later) |
| 10 | - npm or yarn |
| 11 | |
| 12 | ### Setup |
| 13 | |
| 14 | 1. Install dependencies: |
| 15 | ```bash |
| 16 | cd docs |
| 17 | npm install |
| 18 | ``` |
| 19 | |
| 20 | 2. Start the development server: |
| 21 | ```bash |
| 22 | npm start |
| 23 | ``` |
| 24 | |
| 25 | 3. Open your browser and navigate to `http://localhost:8080` |
| 26 | |
| 27 | ### Directory Structure |
| 28 | |
| 29 | ``` |
| 30 | docs/ |
| 31 | ├── _data/ # Global data files |
| 32 | │ ├── navigation.js # Navigation structure |
| 33 | │ └── site.json # Site metadata |
| 34 | ├── _includes/ # Layout templates |
| 35 | │ ├── base.njk # Base layout |
| 36 | │ └── docs.njk # Documentation layout |
| 37 | ├── assets/ # Static assets |
| 38 | │ └── css/ |
| 39 | │ └── style.css # CSS styles |
| 40 | ├── content/ # Markdown content |
| 41 | │ ├── index.md # Homepage/Documentation index |
| 42 | │ ├── getting-started/ |
| 43 | │ │ └── index.md # Getting started guide |
| 44 | │ └── ... # Other documentation pages |
| 45 | ├── .eleventy.js # Eleventy configuration |
| 46 | ├── .gitignore # Git ignore file |
| 47 | └── package.json # Node.js dependencies |
| 48 | ``` |
| 49 | |
| 50 | ### Building |
| 51 | |
| 52 | To build the site: |
| 53 | |
| 54 | ```bash |
| 55 | cd docs |
| 56 | npm run build |
| 57 | ``` |
| 58 | |
| 59 | The built site will be in the `docs/_site` directory. |
| 60 | |
| 61 | ## Deployment |
| 62 | |
| 63 | The site is automatically deployed to GitHub Pages when changes are pushed to the main branch. The deployment is handled by GitHub Actions. |
| 64 | |
| 65 | ## Trademarks |
| 66 | |
| 67 | This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft |
| 68 | trademarks or logos is subject to and must follow |
| 69 | [Microsoft's Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general). |
| 70 | Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. |
| 71 | Any use of third-party trademarks or logos are subject to those third-party's policies. |
| 72 | |