Skip to content

Commit

Permalink
[Docs] site and landing page setup (#45)
Browse files Browse the repository at this point in the history
This PR sets up the `site` directory and the landing page.
  • Loading branch information
MasterJH5574 authored Nov 16, 2024
1 parent 3626b01 commit 8e85a80
Show file tree
Hide file tree
Showing 7 changed files with 85 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@

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,
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.
<!--
## Key Features
Expand Down
8 changes: 8 additions & 0 deletions scripts/local_deploy_site.sh
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
3 changes: 3 additions & 0 deletions site/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
dist
_site
.jekyll-cache
1 change: 1 addition & 0 deletions site/CNAME
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
xgrammar.mlc.ai
7 changes: 7 additions & 0 deletions site/Gemfile
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"
42 changes: 42 additions & 0 deletions site/_config.yml
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
22 changes: 22 additions & 0 deletions site/index.md
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)

0 comments on commit 8e85a80

Please sign in to comment.