Skip to content

Commit

Permalink
docs are now integrated into the website, along with a basic implemen…
Browse files Browse the repository at this point in the history
…tation of the install page and tools page, changed assets, and improved seo.
  • Loading branch information
Ze7111 committed Jul 1, 2024
1 parent d205956 commit 7821864
Show file tree
Hide file tree
Showing 21 changed files with 299 additions and 36 deletions.
Binary file removed .github/images/astros-preview.png
Binary file not shown.
Binary file removed .github/images/astros.gif
Binary file not shown.
Binary file added .github/images/dark-preview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed .github/images/image.png
Binary file not shown.
Binary file added .github/images/light-preview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,8 @@ This project is a modified version of the template [Astros](http://astros.zank.s

![Alt text](.github/images/pagespeed-small.png)

![Helix Preview](.github/images/helix-preview.png)
![Helix-Site Dark Preview](.github/images/dark-preview.png)
![Helix-Site Light Preview](.github/images/light-preview.png)

## 🧪 Test

Expand Down
44 changes: 42 additions & 2 deletions astro.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,8 @@ export default defineConfig({
}),
icon(),
starlight({
title: 'Helix Docs',
title: 'Helix',

logo: {
src: "/public/logo.svg",
replacesTitle: false,
Expand All @@ -70,7 +71,7 @@ export default defineConfig({
social: {
github: 'https://github.com/kneorain/helix',
},
customCss: process.env.NO_GRADIENTS ? [] : ["/src/styles/docstyle.css"],
customCss: ["/src/styles/docstyle.css"],
expressiveCode: {
themes: ['one-dark-pro', 'one-light'],
shiki: {
Expand All @@ -80,7 +81,46 @@ export default defineConfig({
},
styleOverrides: { borderRadius: '0.2rem' },
},
sidebar: [
{
label: 'Welcome To Helix',
link: 'docs',
},
{
label: 'Introduction',
link: 'docs/introduction',
},
{
label: 'Installation',
link: 'docs/installation',
},
{
label: 'Getting Started',
autogenerate: { directory: 'docs/getting-started' },
},
{
label: 'Language',
badge: 'New',
autogenerate: { directory: 'docs/language' },
},
{
label: 'Examples',
badge: 'New',
autogenerate: { directory: 'docs/examples' },
},
{
label: 'Reference',
autogenerate: { directory: 'docs/reference' },
},
{
label: 'Appendix',
badge: 'New',
autogenerate: { directory: 'docs/appendix' },
},
],
tableOfContents: { minHeadingLevel: 2, maxHeadingLevel: 4 },
lastUpdated: true,
disable404Route: true,
})
],
markdown: {
Expand Down
Binary file modified public/meta/opengraph.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion src/components/hero.astro
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ const { dynamic = true } = Astro.props;
{t("hero.subtitle")}
</p>
<div class="mt-10 flex items-center justify-center gap-x-2 md:gap-x-6">
<Link href="https://github.com/kneorain/helix-lang">{t("hero.main_button_text")}</Link
<Link href="/docs/installation">{t("hero.main_button_text")}</Link
>
<Link href="/docs" style="muted">
{t("hero.secondary_button_text")}
Expand Down
2 changes: 1 addition & 1 deletion src/components/navbar/navbar.astro
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import { t } from "i18next";
export const menuitems = [
{
title: "header.install",
path: "/docs/install",
path: "/install",
},
{
title: "header.docs",
Expand Down
4 changes: 3 additions & 1 deletion src/components/pricing.astro
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,9 @@ const { plan } = Astro.props;
{plan.price && typeof plan.price === "object" ? plan.price.monthly : plan.price}
</span>
</p>
<Link href="#" aria-describedby="tier-enterprise" style="outline" class="block w-full mt-6">{plan.button.text || "Get Started"}</Link>
<!--- make a spacer to make sure all the buttons of this inst are in the same height -->
<div class="flex-grow"></div>
<Link href={plan.button.link} aria-describedby="tier-enterprise" style="outline" class="block w-full mt-6">{plan.button.text || "Learn More"}</Link>
<ul role="list" class="mt-8 space-y-3 text-sm leading-6 text-gray-600 dark:text-gray-300 xl:mt-10">
{
plan.features.map((item) => (
Expand Down
5 changes: 5 additions & 0 deletions src/content/docs/docs/installation.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: Installation
---

how to install or work on helix
File renamed without changes.
5 changes: 5 additions & 0 deletions src/content/docs/docs/reference/helios.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: Helios
---

helios the package manager
5 changes: 5 additions & 0 deletions src/content/docs/docs/reference/helix-ai.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: Helix AI
---

the subsytem toolchain that allows for a custom ai model to run locally and opimize raw llvm ir
5 changes: 5 additions & 0 deletions src/content/docs/docs/reference/helix-analyzer.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: Helix Analyzer
---

LSP support for helix
2 changes: 1 addition & 1 deletion src/layouts/Layout.astro
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ const makeTitle = title
<link rel="stylesheet" href="/index.css" />

<SEO
title="Helix Programming Language - High-Performance Interoperable Development"
title="Helix"
description="Helix is a high-performance, general-purpose programming language that seamlessly integrates with C++, Rust, and Python. Build robust, efficient, and maintainable applications with Helix."
canonical={canonicalURL}
openGraph={{
Expand Down
18 changes: 11 additions & 7 deletions src/pages/pricing.astro → src/pages/install.astro
Original file line number Diff line number Diff line change
Expand Up @@ -71,14 +71,18 @@ const pricingData = [
<Layout title="Pricing">
<Container>
<Sectionhead>
<Fragment slot="title">Pricing</Fragment>
<Fragment slot="desc">Affordable Excellence: See Our Pricing.</Fragment>
<Fragment slot="title">Installing Helix (recomended way)</Fragment>
<Fragment slot="desc">Two ways, either install a pre-built binary or install with a shell script.</Fragment>
</Sectionhead>

<div class="grid md:grid-cols-3 gap-10 mx-auto max-w-4xl mt-20">
{pricingData.map((item) => <Pricing plan={item} />)}
</div>
<!-- <Logos /> -->
<Faq />
<Sectionhead>
<Fragment slot="title">Installing Helix (building from source)</Fragment>
<Fragment slot="desc">This way consists of a quite lengthy process that involves building the compiler from source.</Fragment>
</Sectionhead>

<Sectionhead>
<Fragment slot="title">Adding helix to PATH</Fragment>
<Fragment slot="desc">This is applicable to all the installation methods.</Fragment>
</Sectionhead>
</Container>
</Layout>
79 changes: 79 additions & 0 deletions src/pages/tools.astro
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
---
import Container from "@components/container.astro";
import Faq from "@components/faq.astro";
import Logos from "@components/logos.astro";
import Pricing from "@components/pricing.astro";
import Sectionhead from "@components/sectionhead.astro";
import Layout from "@layouts/Layout.astro";
import { changeLanguage } from "i18next";
changeLanguage("en");
const pricingData = [
{
name: "IDE Intergration",
price: "Helix Analyzer",
popular: false,
features: [
"Errors, Warnings, and Notes support",
"Can analyze for runtime errors",
"Follows the Language Server Protocall",
"Open-AI/SwaggerUI API refrence",
"Open Source",
],
button: {
text: "Learn More",
link: "docs/reference/helix-analyzer",
},
},
{
name: "Package Manager",
price: "Helios",
popular: true,
features: [
"Install, and Remove packages with ease",
"Works with pip, cargo, brew, and vcpkg",
"Project manager",
"Build Tool",
"Extensible",
"High Performance",
"Open Source",
],
button: {
text: "Learn More",
link: "docs/reference/helios",
},
},
{
name: "Optimization",
price: "Helix AI",
popular: false,
features: [
"Uses AI to optimize helix llvm ir",
"Runs AI model locally",
"Produces truly effient code",
"Can result in magnitudets of performance increase",
"Open Source",
],
button: {
text: "Learn More",
link: "docs/reference/helix-ai",
},
},
];
---

<Layout title="Pricing">
<Container>
<Sectionhead>
<Fragment slot="title">Tools</Fragment>
<Fragment slot="desc">Helix comes with great tools inbuilt, such as IDE intergrations and other neet features.</Fragment>
</Sectionhead>

<div class="grid md:grid-cols-3 gap-10 mx-auto max-w-4xl mt-20">
{pricingData.map((item) => <Pricing plan={item} />)}
</div>
<!-- <Logos /> -->
<Faq />
</Container>
</Layout>
Loading

0 comments on commit 7821864

Please sign in to comment.