uqbar-project/website-wollok-ts

Wollok Web Site

Wollok Programming Language Web Site - TS implementation

If you are looking for the Wollok Xtext Implementation Site, please visit http://xtext.wollok.org

Technologies

Astro + Starlight
- Starlight’s docs
- Astro documentation

🚀 Project Structure

Like any Astro + Starlight project, you'll see the following folders and files:

.
├── public/
├── src/
│   ├── assets/
│   ├── content/
│   │   ├── docs/
│   │   └── config.ts
│   └── env.d.ts
├── astro.config.mjs
├── package.json
└── tsconfig.json

starlight looks for .md or .mdx files in the src/content/docs/ directory.
each file is exposed as a route based on its file name.
images can be added to src/assets/ and embedded in Markdown with a relative link.
static assets, like favicons, can be placed in the public/ directory.

🧞 Commands

All commands are run from the root of the project, from a terminal:

Command	Action
`npm install`	Installs dependencies
`npm run dev`	Starts local dev server at `localhost:4321`
`npm run build`	Build your production site to `./dist/`
`npm run preview`	Preview your build locally, before deploying
`npm run astro ...`	Run CLI commands like `astro add`, `astro check`
`npm run astro -- --help`	Get help using the Astro CLI

🚀 Site deployment

Just push into the main branch and it automatically deploys using Github pages.

For more information please check deploy.yaml file.

💻 Developer environment

You will need an Astro editor. We recomend Visual Studio Code with some extensions.

You can download and import this profile in your Visual Studio Code. See this tutorial if you have any question.

Alternative: manually install VSC extensions

Make sure you install the following extensions:

Installing node, npm & nvm

Follow the instructions on Wollok TS page about installing Node, NPM & nvm.

👩‍💻 Contributing

All contributions are welcome!

You can join the Discord channel!
There's a list of good first issues to tackle, but in case of any hesitation you can always ping @PalumboN or @fdodino
You can fork the project and create a Pull Request. If you've never collaborated with an open source project before, you might want to read this guide