-
Notifications
You must be signed in to change notification settings - Fork 53
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[Docs]
site
and landing page setup (#45)
This PR sets up the `site` directory and the landing page.
- Loading branch information
1 parent
3626b01
commit 8e85a80
Showing
7 changed files
with
85 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
#!/bin/bash | ||
# NOTE: use this script to check local site | ||
|
||
set -euxo pipefail | ||
|
||
scripts/build_site.sh | ||
|
||
cd site && jekyll serve --skip-initial-build --host localhost --baseurl / --port 8888 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
dist | ||
_site | ||
.jekyll-cache |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
xgrammar.mlc.ai |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
# frozen_string_literal: true | ||
|
||
source "https://rubygems.org" | ||
|
||
# gem "rails" | ||
gem "jekyll-remote-theme" | ||
gem "jekyll-sass-converter" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
name: "XGrammar" | ||
short_name: "XGrammar" | ||
|
||
url: https://xgrammar.mlc.ai/ | ||
|
||
exclude: [README.md, serve_local.sh] | ||
|
||
plugins: | ||
- jekyll-remote-theme | ||
|
||
remote_theme: mlc-ai/jekyll-theme-mlc | ||
|
||
|
||
# Colorize code snippets with the rogue module if we want to deploy on GH. | ||
highlighter: rouge | ||
|
||
markdown: kramdown | ||
|
||
# The path structure for blog posts. | ||
permalink: /blog/:year/:month/:day/:title.html | ||
|
||
# Number of news stories on the front page. | ||
front_page_news: 8 | ||
|
||
# Base pathname for links. | ||
base: '' | ||
|
||
# make pages for the _projects folder | ||
collections: | ||
projects: | ||
output: true | ||
|
||
course_title: | ||
|
||
# Navigation bar links. | ||
navigation: | ||
- title: Home | ||
link: / | ||
- title: Docs | ||
link: /docs | ||
- title: Github | ||
link: https://github.com/mlc-ai/xgrammar |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
--- | ||
layout: default | ||
title: Home | ||
notitle: true | ||
--- | ||
|
||
## Overview | ||
|
||
XGrammar is open-source solution for flexible, portable, and fast structured generations, | ||
aiming at bring flexible zero-overhead structure generation everywhere. | ||
It supports general context-free grammar to enable a broad range of structures while bringing careful system optimizations to enable fast executions. | ||
XGrammar features a minimal and portable C++ backend that can be easily integrated into multiple environments and frameworks, | ||
and is co-designed with the LLM inference engine and enables zero-overhead structured generation in LLM inference. | ||
|
||
## Get Started | ||
|
||
Please visit our [documentation](https://xgrammar.mlc.ai/docs/) to get started with XGrammar. | ||
- [Installation](https://xgrammar.mlc.ai/docs/start/install) | ||
- [Quick start](https://xgrammar.mlc.ai/docs/start/quick_start) | ||
|
||
## Links | ||
- [XGrammar Github](https://github.com/mlc-ai/xgrammar) |