Skip to content

Commit 56b9ecb

Browse files
tomlin7tomlin7
committed
docs: New custom homepage for the documentation website
1 parent 2e92b0d commit 56b9ecb

File tree

5 files changed

+246
-97
lines changed

5 files changed

+246
-97
lines changed

‎.gitignore‎

Lines changed: 105 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ extensions/*
66
biscuit.build
77
biscuit.dist
88

9+
910
# Byte-compiled / optimized / DLL files
1011
__pycache__/
1112
*.py[cod]
@@ -22,6 +23,8 @@ dist/
2223
downloads/
2324
eggs/
2425
.eggs/
26+
lib/
27+
lib64/
2528
parts/
2629
sdist/
2730
var/
@@ -36,6 +39,7 @@ MANIFEST
3639
# Usually these files are written by a python script from a template
3740
# before PyInstaller builds the exe, so as to inject date/other infos into it.
3841
*.manifest
42+
*.spec
3943

4044
# Installer logs
4145
pip-log.txt
@@ -56,13 +60,112 @@ coverage.xml
5660
.pytest_cache/
5761
cover/
5862

59-
# PEP 582;
63+
# Translations
64+
*.mo
65+
*.pot
66+
67+
# Django stuff:
68+
*.log
69+
local_settings.py
70+
db.sqlite3
71+
db.sqlite3-journal
72+
73+
# Flask stuff:
74+
instance/
75+
.webassets-cache
76+
77+
# Scrapy stuff:
78+
.scrapy
79+
80+
# Sphinx documentation
81+
docs/_build/
82+
83+
# PyBuilder
84+
.pybuilder/
85+
target/
86+
87+
# Jupyter Notebook
88+
.ipynb_checkpoints
89+
90+
# IPython
91+
profile_default/
92+
ipython_config.py
93+
94+
# pyenv
95+
# For a library or package, you might want to ignore these files since the code is
96+
# intended to run in multiple environments; otherwise, check them in:
97+
# .python-version
98+
99+
# pipenv
100+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
101+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
102+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
103+
# install all needed dependencies.
104+
#Pipfile.lock
105+
106+
# poetry
107+
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
108+
# This is especially recommended for binary packages to ensure reproducibility, and is more
109+
# commonly ignored for libraries.
110+
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
111+
#poetry.lock
112+
113+
# pdm
114+
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
115+
#pdm.lock
116+
# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
117+
# in version control.
118+
# https://pdm.fming.dev/latest/usage/project/#working-with-version-control
119+
.pdm.toml
120+
.pdm-python
121+
.pdm-build/
122+
123+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
60124
__pypackages__/
61125

126+
# Celery stuff
127+
celerybeat-schedule
128+
celerybeat.pid
129+
130+
# SageMath parsed files
131+
*.sage.py
132+
62133
# Environments
134+
.env
63135
.venv
64136
env/
65137
venv/
66138
ENV/
67139
env.bak/
68-
venv.bak/
140+
venv.bak/
141+
142+
# Spyder project settings
143+
.spyderproject
144+
.spyproject
145+
146+
# Rope project settings
147+
.ropeproject
148+
149+
# mkdocs documentation
150+
/site
151+
152+
# mypy
153+
.mypy_cache/
154+
.dmypy.json
155+
dmypy.json
156+
157+
# Pyre type checker
158+
.pyre/
159+
160+
# pytype static type analyzer
161+
.pytype/
162+
163+
# Cython debug symbols
164+
cython_debug/
165+
166+
# PyCharm
167+
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
168+
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
169+
# and can be added to the global gitignore or merged into this file. For a more nuclear
170+
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
171+
#.idea/

‎docs/index.md‎

Lines changed: 7 additions & 91 deletions
Original file line numberDiff line numberDiff line change
@@ -1,91 +1,7 @@
1-
<h1 align="center">
2-
<img src="https://github.com/tomlin7/Biscuit/assets/70792552/0ea8e958-92de-4659-b1c9-ab5a72f05d7d" width=500><br>
3-
<a href=https://github.com/tomlin7/Biscuit/actions/workflows/nightly.yml>
4-
<img src="https://img.shields.io/github/actions/workflow/status/tomlin7/biscuit/nightly.yml?style=for-the-badge">
5-
</a>
6-
<img alt="Project License" src="https://img.shields.io/github/license/tomlin7/Biscuit?style=for-the-badge">
7-
<a href=https://github.com/tomlin7/Biscuit/releases>
8-
<img alt="Download Latest" src="https://img.shields.io/github/v/release/tomlin7/biscuit?style=for-the-badge">
9-
</a>
10-
<img alt="GitHub closed pull requests" src="https://img.shields.io/github/issues-pr-closed-raw/tomlin7/Biscuit?style=for-the-badge">
11-
</h1>
12-
13-
A lightweight, fast, and extensible code editor with wide range of language support, runs with very minimal system requirements. It implements the [Language Server Protocol](https://microsoft.github.io/language-server-protocol/) for code completions, refactoring, symbol references, and more. Features include breakpoint-based code debugging, AI assisted workflow, fast workspace search, and built-in Git support. Scroll down to see [biscuit in action](https://github.com/tomlin7/Biscuit/tree/main?tab=readme-ov-file#features).
14-
15-
![image](https://github.com/tomlin7/biscuit/assets/70792552/74118e72-e7de-48dd-a34f-a5abd6664e42)
16-
17-
- 🎀 Explore all community made extensions and their authors at the [Biscuit Extension Center](https://tomlin7.github.io/biscuit-extensions/)
18-
- 🪛 For contributing/user guides or API reference, check the [documentation here](https://tomlin7.github.io/biscuit)
19-
- 🌟 Scroll down to the [features section](https://github.com/tomlin7/biscuit?tab=readme-ov-file#features) for a list of all features
20-
21-
## Installing
22-
23-
You can install the latest release from PyPI by running:
24-
25-
```bash
26-
pip install biscuit-editor
27-
```
28-
29-
Try running `biscuit --version` in your terminal to check if the installation was successful.
30-
31-
### Standalone Builds
32-
33-
- Grab the latest stable build from [**releases page**](https://github.com/tomlin7/Biscuit/releases)
34-
- Unstable nightly builds from [GitHub actions](https://github.com/tomlin7/Biscuit/actions)
35-
36-
For compiling from source code, please check the [installation guide](https://github.com/tomlin7/Biscuit/tree/main/scripts).
37-
38-
## Contributing ❤️
39-
40-
Your contributions are valuable and very much appreciated!
41-
Have a peek at the [contributing guide](https://github.com/tomlin7/Biscuit/blob/main/CONTRIBUTING.md) for a quick tour on project structure and to setup the environment. To contribute a new extension, check the [extension docs](https://github.com/tomlin7/biscuit-extensions).
42-
43-
<a href="https://github.com/tomlin7/biscuit/graphs/contributors">
44-
<img src="https://opencollective.com/biscuit/contributors.svg" />
45-
</a><br>
46-
47-
- For opening feature requests and bug reports, use the [issue tracker](https://github.com/tomlin7/Biscuit/issues)
48-
- Community made extensions are published at the [extensions repository](https://github.com/tomlin7/biscuit-extensions)
49-
50-
## Features
51-
52-
- **Language Server Support** for code completions, refactoring, symbol references, and more
53-
54-
![peek](https://github.com/tomlin7/biscuit/assets/70792552/be132f5b-776c-4045-8a62-c9d29d463762)
55-
56-
<table>
57-
<tr>
58-
<img src=https://github.com/tomlin7/biscuit/assets/70792552/36589a2d-8f5f-4196-bc88-5b1800492076 height=270>
59-
</tr>
60-
<tr>
61-
<img src=https://github.com/tomlin7/biscuit/assets/70792552/68a26ccb-b309-4c21-b75e-3e5cf5fa6500 height=270>
62-
</tr>
63-
</table>
64-
65-
<hr>
66-
67-
- **Breakpoint-based Code Debugging** with variable inspection, call stack, and more
68-
69-
![peek](https://github.com/tomlin7/biscuit/assets/70792552/29541b9e-e084-42bc-85b2-4d7c54cd8d34)
70-
71-
<hr>
72-
73-
- **AI Assisted Workflow** for refactoring, code generation, and more
74-
75-
![peek](https://github.com/tomlin7/biscuit/assets/70792552/97913c12-5493-4783-b1f0-ee904f67ff2d)
76-
77-
<hr>
78-
79-
- **Fast Workspace Search** with regex support and file preview
80-
81-
![peek](https://github.com/tomlin7/biscuit/assets/70792552/de0540b2-2b34-4be6-aa86-97e17a20d47d)
82-
83-
<hr>
84-
85-
- **Built-in Git Support** for version control and diff viewer
86-
87-
![image](https://github.com/tomlin7/biscuit/assets/70792552/ad650048-7e74-420b-bd3a-d0c059ff69cd)
88-
89-
## License
90-
91-
Biscuit is released under the MIT License; for more information, see [LICENSE](https://github.com/tomlin7/Biscuit/blob/main/LICENSE.md).
1+
---
2+
template: home.html
3+
title: Biscuit
4+
social:
5+
cards_layout_options:
6+
title: A lightweight, fast, and extensible code editor with a wide range of language support.
7+
---

‎docs/overrides/home.html‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
{% extends "main.html" %}
2+
{% block tabs %}
3+
{{ super() }}
4+
<style>.md-header{position:initial}.md-main__inner{margin:0}.md-content{display:none}@media screen and (min-width:60em){.md-sidebar--secondary{display:none}}@media screen and (min-width:76.25em){.md-sidebar--primary{display:none}}</style>
5+
<section class="mdx-container">
6+
<div class="md-grid md-typeset">
7+
<div class="mdx-hero">
8+
<div class="mdx-hero__image">
9+
<img class="animate" src="https://github.com/tomlin7/Biscuit/assets/70792552/844000b3-c28c-4a76-a780-70790dd27844" />
10+
</div>
11+
<div class="mdx-hero__content">
12+
<h1>Biscuit</h1>
13+
<p>{{ config.site_description }}. Set up in 5 minutes.</p>
14+
<a href="{{ page.next_page.url | url }}" title="{{ page.next_page.title | e }}" class="md-button md-button--primary">
15+
Quick start
16+
</a>
17+
<a href="{{ 'api/app' | url }}" title="API Reference" class="md-button">
18+
API Reference
19+
</a>
20+
</div>
21+
</div>
22+
</div>
23+
</section>
24+
{% endblock %}
25+
{% block content %}{% endblock %}
26+
{% block footer %}{% endblock %}

‎docs/stylesheets/extra.css‎

Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
.animate {
2+
filter: drop-shadow(0 0 0.5rem rgba(0, 0, 0, 0.06));
3+
animation: gliding-animation 3s infinite ease-in-out;
4+
transition: all 1s ease-in, filter 0.3s ease-in;
5+
}
6+
7+
@keyframes gliding-animation {
8+
50% {
9+
transform: translateY(-15px);
10+
}
11+
}
12+
13+
.animate:hover, .animate:focus {
14+
transform: scale(1.01);
15+
filter: drop-shadow(0 0 0.5rem rgba(0, 0, 0, 0.12));
16+
}
17+
18+
.md-banner {
19+
color: var(--md-footer-fg-color--lighter);
20+
}
21+
22+
.mdx-container {
23+
background: url("data:image/svg+xml;utf8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 1123 258'><path d='M1124,2c0,0 0,256 0,256l-1125,0l0,-48c0,0 16,5 55,5c116,0 197,-92 325,-92c121,0 114,46 254,46c140,0 214,-167 572,-166Z' style='fill: hsla(0, 0%, 100%, 1)' /></svg>")
24+
no-repeat bottom,
25+
linear-gradient(to bottom, var(--md-primary-fg-color), #aa6114 99%, var(--md-default-bg-color) 99%);
26+
padding-top: 1rem;
27+
}
28+
[data-md-color-scheme="slate"] .mdx-container {
29+
background: url("data:image/svg+xml;utf8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 1123 258'><path d='M1124,2c0,0 0,256 0,256l-1125,0l0,-48c0,0 16,5 55,5c116,0 197,-92 325,-92c121,0 114,46 254,46c140,0 214,-167 572,-166Z' style='fill: hsla(230, 15%, 14%, 1)' /></svg>")
30+
no-repeat bottom,
31+
linear-gradient(to bottom, var(--md-primary-fg-color), #aa6114 99%, var(--md-default-bg-color) 99%);
32+
}
33+
34+
.mdx-hero {
35+
color: var(--md-primary-bg-color);
36+
margin: 0 3rem;
37+
}
38+
39+
.mdx-hero h1 {
40+
color: var(--md-primary-bg-color);
41+
font-size: 3rem;
42+
font-weight: 700;
43+
margin-bottom: 1rem;
44+
}
45+
46+
47+
@media screen and (max-width:29.984375em) {
48+
.mdx-hero h1 {
49+
font-size: 1.4rem;
50+
}
51+
}
52+
.mdx-hero__content {
53+
padding-bottom: 6rem;
54+
}
55+
56+
@media screen and (min-width:60em) {
57+
.mdx-hero {
58+
align-items: stretch;
59+
display: flex;
60+
}
61+
.mdx-hero__content {
62+
margin-top: 3.5rem;
63+
max-width: 19rem;
64+
padding-bottom: 14vw;
65+
}
66+
.mdx-hero__image {
67+
order: 1;
68+
transform: translateX(4rem);
69+
width: 38rem;
70+
}
71+
}
72+
73+
@media screen and (min-width:76.25em) {
74+
.mdx-hero__image {
75+
transform: translateX(15rem) translateY(5rem);
76+
}
77+
}
78+
79+
.mdx-hero .md-button {
80+
color: var(--md-primary-bg-color);
81+
margin-right: .5rem;
82+
margin-top: .5rem;
83+
}
84+
85+
.mdx-hero .md-button:focus, .mdx-hero .md-button:hover {
86+
background-color: var(--md-accent-fg-color);
87+
border-color: var(--md-accent-fg-color);
88+
color: var(--md-accent-bg-color);
89+
}
90+
91+
.mdx-hero .md-button--primary {
92+
background-color: var(--md-primary-bg-color);
93+
border-color: var(--md-primary-bg-color);
94+
color: #aa6114;
95+
}
96+
97+
98+

0 commit comments

Comments
 (0)