https://github.com/luals/luals.github.io

Statically generated website for LuaLS using Astro.
https://github.com/luals/luals.github.io

astrojs lua-language-server sumneko-lua

Last synced: 6 days ago
JSON representation

Statically generated website for LuaLS using Astro.

• Host: GitHub
• URL: https://github.com/luals/luals.github.io
• Owner: LuaLS
• Created: 2023-07-03T23:52:57.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-09-16T04:01:02.000Z (about 2 months ago)
• Last Synced: 2024-09-17T05:23:27.833Z (about 2 months ago)
• Topics: astrojs, lua-language-server, sumneko-lua
• Language: MDX
• Homepage: https://luals.github.io/
• Size: 11.8 MB
• Stars: 5
• Watchers: 2
• Forks: 13
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Contributing: docs/CONTRIBUTING-WIKI.md

Awesome Lists containing this project

README

        
# LuaLS Website

This website explains the [lua-language-server](https://github.com/LuaLS/lua-language-server) and documents it via a [wiki](https://luals.github.io/wiki). The website is statically generated using [Astro](https://astro.build) 🚀.

## Project File Structure

- `/public/` All of the assets available from the root of the website such as images, fonts, etc.

- [`/src/components/`](./src/components/) reusable `.astro` components

  - [`/src/components/common/`](./src/components/common) common components used all over the website

  - `/src/components/layout/` components used in layouts such as headers and footers

  - [`/src/components/wiki/`](./src/components/wiki/) components used in the wiki

- `/src/content/` Content-full MDX and Markdown files used in the wiki

- `/src/layouts/` Various reusable layouts

- `/src/pages/` The pages of the website

- `/src/scss/` Common SCSS

## Developing

See the [contributing guide](./docs/CONTRIBUTING.md).

To get started, run `npm i` to install the dependencies.

You can then use `npm run dev` to start a local development server on `localhost:3000`.

`npm run build` will build the site for production so it can be previewed. `npm run preview` will preview your build of the website.

## Acknowledgments

This website uses tons of amazing open source software. Thanks to all the [great tools in use](package.json)!