klbr/khoj
1
0
Fork 0
mirror of https://github.com/khoaliber/khoj.git synced 2026-03-05 13:21:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

Make the docs overview page as the main docs landing page

Browse Source 
- Make the docs overview page available at docs.khoj.dev root instead of
under docs.khoj.dev/docs path
  - Remove the new landing page, it is unnecessary.
- Remove /docs path prefix from links to internal doc pages
- Remove .md path suffix in internal doc pages for consistency
This commit is contained in:
Debanjum Singh Solanky
2024-01-08 00:32:23 +05:30
parent 80d1ad5b6f
commit d920e4d0a7
15 changed files with 30 additions and 390 deletions
Download Patch File Download Diff File Expand all files Collapse all files

61
documentation/src/components/HomepageFeatures/index.js
View File

@@ -1,61 +0,0 @@
import clsx from 'clsx';
import Heading from '@theme/Heading';
import styles from './styles.module.css';
const FeatureList = [
{
title: 'Connect your knowledge',
Svg: require('@site/assets/img/mountains-lake.svg').default,
description: (
<>
Khoj can understand your PDFs, markdown, org, and other plaintext files. Connect your knowledge base using one of our <a href="https://khoj.dev/downloads">desktop apps</a> or <a href="/docs/category/clients">other client apps</a>.
</>
),
},
{
title: 'Simplify your thinking',
Svg: require('@site/assets/img/lightbulb-plant.svg').default,
description: (
<>
Get your knowledge base out of your head and into Khoj. Khoj is a tool for thinking, learning, and making things.
</>
),
},
{
title: 'Run privately',
Svg: require('@site/assets/img/folder_security.svg').default,
description: (
<>
You can run Khoj on your own computer, or on your own server. All of our code is open source, and you can <a href="/docs/get-started/setup">set it up</a> in minutes.
</>
),
},
];
function Feature({Svg, title, description}) {
return (
<div className={clsx('col col--4')}>
<div className="text--center">
<Svg className={styles.featureSvg} role="img" />
</div>
<div className="text--center padding-horiz--md">
<Heading as="h3">{title}</Heading>
<p>{description}</p>
</div>
</div>
);
}
export default function HomepageFeatures() {
return (
<section className={styles.features}>
<div className="container">
<div className="row">
{FeatureList.map((props, idx) => (
<Feature key={idx} {...props} />
))}
</div>
</div>
</section>
);
}

43
documentation/src/pages/index.js
View File

@@ -1,43 +0,0 @@
import clsx from 'clsx';
import Link from '@docusaurus/Link';
import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
import Layout from '@theme/Layout';
import HomepageFeatures from '@site/src/components/HomepageFeatures';
import Heading from '@theme/Heading';
import styles from './index.module.css';
function HomepageHeader() {
const {siteConfig} = useDocusaurusContext();
return (
<header className={clsx('hero hero--primary', styles.heroBanner)}>
<div className="container">
<Heading as="h1" className="hero__title">
{siteConfig.title}
</Heading>
<p className="hero__subtitle">{siteConfig.tagline}</p>
<div className={styles.buttons}>
<Link
className="button button--secondary button--lg"
to="/docs/get-started/overview">
Get Started →
</Link>
</div>
</div>
</header>
);
}
export default function Home() {
const {siteConfig} = useDocusaurusContext();
return (
<Layout
title={`👋🏽 from ${siteConfig.title}`}
description="Get started with the Khoj Documentation">
<HomepageHeader />
<main>
<HomepageFeatures />
</main>
</Layout>
);
}

23
documentation/src/pages/index.module.css
View File

@@ -1,23 +0,0 @@
/**
* CSS files with the .module.css suffix will be treated as CSS modules
* and scoped locally.
*/
.heroBanner {
padding: 4rem 0;
text-align: center;
position: relative;
overflow: hidden;
}
@media screen and (max-width: 996px) {
.heroBanner {
padding: 2rem;
}
}
.buttons {
display: flex;
align-items: center;
justify-content: center;
}

7
documentation/src/pages/markdown-page.md
View File

@@ -1,7 +0,0 @@
---
title: Markdown page example
---
# Markdown page example
You don't need React to write simple standalone pages.