https://github.com/llvm/mlir-www

https://github.com/llvm/mlir-www

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/llvm/mlir-www
• Owner: llvm
• Created: 2019-12-09T15:26:27.000Z (almost 5 years ago)
• Default Branch: main
• Last Pushed: 2024-04-14T00:37:04.000Z (5 months ago)
• Last Synced: 2024-04-14T03:56:59.483Z (5 months ago)
• Language: SCSS
• Size: 131 MB
• Stars: 58
• Watchers: 20
• Forks: 103
• Open Issues: 11
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# MLIR WWW

This contains the source code for https://mlir.llvm.org/ ; which is rendered

from the `gh-pages` branch of the same repo using GitHub pages.

To contribute, feel free to fork this repository and send a pull-request.

The website is deployed on every push to this repository using a GitHub

action defined in `.github/workflows/main.yml`. It also runs every 4 hours

to catch updates from the MLIR source repository (the LLVM monorepo), which

is used for generating some docs.

We are using the [Hugo](https://gohugo.io/) framework for generating the

website. The source pages are written in Markdown format under the

`website/content` folder.

A large part of the documentation is auto-generated from the MLIR source

code. See the workflow `.github/workflows/main.yml` for the instructions

to reproduce the entirety of https://mlir.llvm.org/ locally.

After running the code from the workflow, download hugo on your machine, and

run `hugo server` from the `website` directory. You can then access a local

version of the website from ; any change you

make to the source Markdown will automatically be refreshed by the local

hugo server.

When making changes it is often not useful to check out the doxygen branch

so consider checking out only the main branch. For example, if using

[gh](https://cli.github.com/), only the following is needed

```sh

gh repo clone llvm/mlir-www -- --single-branch --branch main

```