-
Notifications
You must be signed in to change notification settings - Fork 27
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: New custom homepage for the documentation website
- Loading branch information
Showing
5 changed files
with
246 additions
and
97 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 |
|---|---|---|
| @@ -1,91 +1,7 @@ | ||
| <h1 align="center"> | ||
| <img src="https://github.com/tomlin7/Biscuit/assets/70792552/0ea8e958-92de-4659-b1c9-ab5a72f05d7d" width=500><br> | ||
| <a href=https://github.com/tomlin7/Biscuit/actions/workflows/nightly.yml> | ||
| <img src="https://img.shields.io/github/actions/workflow/status/tomlin7/biscuit/nightly.yml?style=for-the-badge"> | ||
| </a> | ||
| <img alt="Project License" src="https://img.shields.io/github/license/tomlin7/Biscuit?style=for-the-badge"> | ||
| <a href=https://github.com/tomlin7/Biscuit/releases> | ||
| <img alt="Download Latest" src="https://img.shields.io/github/v/release/tomlin7/biscuit?style=for-the-badge"> | ||
| </a> | ||
| <img alt="GitHub closed pull requests" src="https://img.shields.io/github/issues-pr-closed-raw/tomlin7/Biscuit?style=for-the-badge"> | ||
| </h1> | ||
|
|
||
| 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). | ||
|
|
||
|  | ||
|
|
||
| - 🎀 Explore all community made extensions and their authors at the [Biscuit Extension Center](https://tomlin7.github.io/biscuit-extensions/) | ||
| - 🪛 For contributing/user guides or API reference, check the [documentation here](https://tomlin7.github.io/biscuit) | ||
| - 🌟 Scroll down to the [features section](https://github.com/tomlin7/biscuit?tab=readme-ov-file#features) for a list of all features | ||
|
|
||
| ## Installing | ||
|
|
||
| You can install the latest release from PyPI by running: | ||
|
|
||
| ```bash | ||
| pip install biscuit-editor | ||
| ``` | ||
|
|
||
| Try running `biscuit --version` in your terminal to check if the installation was successful. | ||
|
|
||
| ### Standalone Builds | ||
|
|
||
| - Grab the latest stable build from [**releases page**](https://github.com/tomlin7/Biscuit/releases) | ||
| - Unstable nightly builds from [GitHub actions](https://github.com/tomlin7/Biscuit/actions) | ||
|
|
||
| For compiling from source code, please check the [installation guide](https://github.com/tomlin7/Biscuit/tree/main/scripts). | ||
|
|
||
| ## Contributing ❤️ | ||
|
|
||
| Your contributions are valuable and very much appreciated! | ||
| 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). | ||
|
|
||
| <a href="https://github.com/tomlin7/biscuit/graphs/contributors"> | ||
| <img src="https://opencollective.com/biscuit/contributors.svg" /> | ||
| </a><br> | ||
|
|
||
| - For opening feature requests and bug reports, use the [issue tracker](https://github.com/tomlin7/Biscuit/issues) | ||
| - Community made extensions are published at the [extensions repository](https://github.com/tomlin7/biscuit-extensions) | ||
|
|
||
| ## Features | ||
|
|
||
| - **Language Server Support** for code completions, refactoring, symbol references, and more | ||
|
|
||
|  | ||
|
|
||
| <table> | ||
| <tr> | ||
| <img src=https://github.com/tomlin7/biscuit/assets/70792552/36589a2d-8f5f-4196-bc88-5b1800492076 height=270> | ||
| </tr> | ||
| <tr> | ||
| <img src=https://github.com/tomlin7/biscuit/assets/70792552/68a26ccb-b309-4c21-b75e-3e5cf5fa6500 height=270> | ||
| </tr> | ||
| </table> | ||
|
|
||
| <hr> | ||
|
|
||
| - **Breakpoint-based Code Debugging** with variable inspection, call stack, and more | ||
|
|
||
|  | ||
|
|
||
| <hr> | ||
|
|
||
| - **AI Assisted Workflow** for refactoring, code generation, and more | ||
|
|
||
|  | ||
|
|
||
| <hr> | ||
|
|
||
| - **Fast Workspace Search** with regex support and file preview | ||
|
|
||
|  | ||
|
|
||
| <hr> | ||
|
|
||
| - **Built-in Git Support** for version control and diff viewer | ||
|
|
||
|  | ||
|
|
||
| ## License | ||
|
|
||
| Biscuit is released under the MIT License; for more information, see [LICENSE](https://github.com/tomlin7/Biscuit/blob/main/LICENSE.md). | ||
| --- | ||
| template: home.html | ||
| title: Biscuit | ||
| social: | ||
| cards_layout_options: | ||
| title: A lightweight, fast, and extensible code editor with a wide range of language support. | ||
| --- |
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,26 @@ | ||
| {% extends "main.html" %} | ||
| {% block tabs %} | ||
| {{ super() }} | ||
| <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> | ||
| <section class="mdx-container"> | ||
| <div class="md-grid md-typeset"> | ||
| <div class="mdx-hero"> | ||
| <div class="mdx-hero__image"> | ||
| <img class="animate" src="https://github.com/tomlin7/Biscuit/assets/70792552/844000b3-c28c-4a76-a780-70790dd27844" /> | ||
| </div> | ||
| <div class="mdx-hero__content"> | ||
| <h1>Biscuit</h1> | ||
| <p>{{ config.site_description }}. Set up in 5 minutes.</p> | ||
| <a href="{{ page.next_page.url | url }}" title="{{ page.next_page.title | e }}" class="md-button md-button--primary"> | ||
| Quick start | ||
| </a> | ||
| <a href="{{ 'api/app' | url }}" title="API Reference" class="md-button"> | ||
| API Reference | ||
| </a> | ||
| </div> | ||
| </div> | ||
| </div> | ||
| </section> | ||
| {% endblock %} | ||
| {% block content %}{% endblock %} | ||
| {% block footer %}{% endblock %} |
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,98 @@ | ||
| .animate { | ||
| filter: drop-shadow(0 0 0.5rem rgba(0, 0, 0, 0.06)); | ||
| animation: gliding-animation 3s infinite ease-in-out; | ||
| transition: all 1s ease-in, filter 0.3s ease-in; | ||
| } | ||
|
|
||
| @keyframes gliding-animation { | ||
| 50% { | ||
| transform: translateY(-15px); | ||
| } | ||
| } | ||
|
|
||
| .animate:hover, .animate:focus { | ||
| transform: scale(1.01); | ||
| filter: drop-shadow(0 0 0.5rem rgba(0, 0, 0, 0.12)); | ||
| } | ||
|
|
||
| .md-banner { | ||
| color: var(--md-footer-fg-color--lighter); | ||
| } | ||
|
|
||
| .mdx-container { | ||
| 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>") | ||
| no-repeat bottom, | ||
| linear-gradient(to bottom, var(--md-primary-fg-color), #aa6114 99%, var(--md-default-bg-color) 99%); | ||
| padding-top: 1rem; | ||
| } | ||
| [data-md-color-scheme="slate"] .mdx-container { | ||
| 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>") | ||
| no-repeat bottom, | ||
| linear-gradient(to bottom, var(--md-primary-fg-color), #aa6114 99%, var(--md-default-bg-color) 99%); | ||
| } | ||
|
|
||
| .mdx-hero { | ||
| color: var(--md-primary-bg-color); | ||
| margin: 0 3rem; | ||
| } | ||
|
|
||
| .mdx-hero h1 { | ||
| color: var(--md-primary-bg-color); | ||
| font-size: 3rem; | ||
| font-weight: 700; | ||
| margin-bottom: 1rem; | ||
| } | ||
|
|
||
|
|
||
| @media screen and (max-width:29.984375em) { | ||
| .mdx-hero h1 { | ||
| font-size: 1.4rem; | ||
| } | ||
| } | ||
| .mdx-hero__content { | ||
| padding-bottom: 6rem; | ||
| } | ||
|
|
||
| @media screen and (min-width:60em) { | ||
| .mdx-hero { | ||
| align-items: stretch; | ||
| display: flex; | ||
| } | ||
| .mdx-hero__content { | ||
| margin-top: 3.5rem; | ||
| max-width: 19rem; | ||
| padding-bottom: 14vw; | ||
| } | ||
| .mdx-hero__image { | ||
| order: 1; | ||
| transform: translateX(4rem); | ||
| width: 38rem; | ||
| } | ||
| } | ||
|
|
||
| @media screen and (min-width:76.25em) { | ||
| .mdx-hero__image { | ||
| transform: translateX(15rem) translateY(5rem); | ||
| } | ||
| } | ||
|
|
||
| .mdx-hero .md-button { | ||
| color: var(--md-primary-bg-color); | ||
| margin-right: .5rem; | ||
| margin-top: .5rem; | ||
| } | ||
|
|
||
| .mdx-hero .md-button:focus, .mdx-hero .md-button:hover { | ||
| background-color: var(--md-accent-fg-color); | ||
| border-color: var(--md-accent-fg-color); | ||
| color: var(--md-accent-bg-color); | ||
| } | ||
|
|
||
| .mdx-hero .md-button--primary { | ||
| background-color: var(--md-primary-bg-color); | ||
| border-color: var(--md-primary-bg-color); | ||
| color: #aa6114; | ||
| } | ||
|
|
||
|
|
||
|
|
Oops, something went wrong.