Skip to content

Commit

Permalink
build(mkdocs): cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
sambacha committed May 24, 2024
1 parent 9196ea8 commit 4a64285
Show file tree
Hide file tree
Showing 5 changed files with 94 additions and 18 deletions.
5 changes: 5 additions & 0 deletions .vscode/extensions.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"recommendations": [
"jzmstrjp.color-the-tag-name"
]
}
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ date: 2024-05-23
# eXtensible Gas Auction (XGA)

Multi-unit auctions, unlike their single-unit counterparts, present complex
allocation mechanisms. The MEV Auction platform implements several innovative
allocation mechanisms. TheXGA platform implements several innovative
strategies:

1. An enhanced uniform price auction,
Expand Down
58 changes: 41 additions & 17 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,15 +1,20 @@
# yamllint disable-line rule:line-length
# yamllint disable rule:document-start
# yamllint disable rule:line-length
# yamllint disable rule:comments-indentation
# yaml-language-server: $schema=https://squidfunk.github.io/mkdocs-material/schema.json

repo_name: manifoldfinance/auction-platform-docs
repo_url: https://github.com/manifoldfinance/auction-platform-docs
site_author: Manifold Finance & 20squares
repo_name: manifoldfinance/docs-xga
repo_url: https://github.com/manifoldfinance/docs-xga
site_author: Manifold Finance
# yamllint disable-line rule:line-length
site_description: MEV Auction documentation for builders, searchers and liquid staking protocols.
site_name: XGA Auctions Documentation
site_description: XGA documentation for builders, searchers and liquid staking protocols.
site_name: XGA Documentation
site_url: https://docs.xga.com
# yamllint disable-line rule:line-length
copyright: Manifold Finance, Inc, 20squares UG, and contributors. Creative Commons Attribution-NonCommercial-NoDerivs 2.5
# Creative Commons Attribution-NonCommercial-NoDerivs 2.5
copyright: >
Copyright © 2022 - 2024 Manifold Finance, Inc.
<a href="#__consent">Change cookie settings</a>
use_directory_urls: true

theme:
Expand All @@ -23,7 +28,7 @@ theme:
- content.code.copy
# - content.code.select
- content.footnote.tooltips
# - content.tabs.link
- content.tabs.link
- content.tooltips
# - header.autohide
# - navigation.expand
Expand Down Expand Up @@ -54,8 +59,8 @@ theme:
name: Switch to light mode
- media: "(prefers-color-scheme: light)"
scheme: default
primary: indigo
accent: indigo
primary: blue-grey
accent: teal
toggle:
icon: material/toggle-switch
name: Switch to dark mode
Expand All @@ -66,9 +71,6 @@ theme:
toggle:
icon: material/toggle-switch-off
name: Switch to system preference
font:
text: Roboto
code: Roboto Mono

extra_css:
# - stylesheets/extra.css
Expand All @@ -84,10 +86,32 @@ extra_javascript:
extra:
is_insider: true
generator: false
google:
site_verification:
- ''
tag_manager: ''
analytics:
provider: google
property: G-RWSFY7TBD5
feedback:
title: Was this page helpful?
ratings:
- icon: material/emoticon-happy-outline
name: This page was helpful
data: 1
note: >-
Thanks for your feedback!
- icon: material/emoticon-sad-outline
name: This page could be improved
data: 0
note: >-
Thanks for your feedback! Help us improve this page by
using our <a href="..." target="_blank" rel="noopener">feedback form</a>.
consent:
actions:
- accept
- reject
- manage
cookies:
analytics:
name: Google Analytics
checked: false

plugins:
- search:
Expand Down
31 changes: 31 additions & 0 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

16 changes: 16 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
{
"name": "docs-xga",
"version": "0.0.1",
"description": "mkdocs website for XGA",
"files": [
"docs",
"src"
],
"repository": "https://github.com/manifoldfinance/docs-xga.git",
"author": "sam bacha <[email protected]>",
"license": "SEE LICENSE IN LICENSE",
"private": false,
"devDependencies": {
"prettier": "^3.2.5"
}
}

0 comments on commit 4a64285

Please sign in to comment.