Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Riley19280 committed Oct 16, 2023
1 parent ae55e72 commit 23e083d
Show file tree
Hide file tree
Showing 14 changed files with 28 additions and 406 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,14 @@

<p align="center">
<img src="https://raw.githubusercontent.com/Riley19280/code-stencil/main/docs/static/img/splash.png" width="600" alt="Code Stencil">
<p align="center">
<a href="https://github.com/riley19280/code-stencil/actions"><img alt="GitHub Workflow Status (master)" src="https://img.shields.io/github/actions/workflow/status/riley19280/code-stencil/run-tests.yml?branch=main&label=Tests"></a>
<a href="https://packagist.org/packages/code-stencil/code-stencil"><img alt="Total Downloads" src="https://img.shields.io/packagist/dt/code-stencil/code-stencil"></a>
<a href="https://packagist.org/packages/code-stencil/code-stencil"><img alt="Latest Version" src="https://img.shields.io/packagist/v/code-stencil/code-stencil"></a>
<a href="https://packagist.org/packages/code-stencil/code-stencil"><img alt="License" src="https://img.shields.io/packagist/l/code-stencil/code-stencil"></a>
</p>
</p>

# Introduction

Code Stencil provides an elegant, easy to read pattern that is great for generating stub files,
Expand Down
6 changes: 3 additions & 3 deletions docs/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -51,12 +51,12 @@ const config = {
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
({
// Replace with your project's social card
image: 'img/docusaurus-social-card.jpg',
image: 'img/splash.png',
navbar: {
title: 'Code Stencil',
logo: {
alt: 'Code Stencil Logo',
src: 'img/logo.svg',
src: 'img/icon.png',
},
items: [
{
Expand All @@ -79,7 +79,7 @@ const config = {
title: 'Docs',
items: [
{
label: 'walkthrough',
label: 'Walkthrough',
to: '/docs/category/walkthrough',
},
],
Expand Down
23 changes: 8 additions & 15 deletions docs/src/components/HomepageFeatures/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -4,48 +4,41 @@ import styles from './styles.module.css';

type FeatureItem = {
title: string;
Svg: React.ComponentType<React.ComponentProps<'svg'>>;
description: JSX.Element;
};

const FeatureList: FeatureItem[] = [
{
title: 'Easy to Use',
Svg: require('@site/static/img/undraw_docusaurus_mountain.svg').default,
description: (
<>
Docusaurus was designed from the ground up to be easily installed and
used to get your website up and running quickly.
Code Stencil provides an easy to use, intuitive interface to make creating templates a breeze!
</>
),
},
{
title: 'Focus on What Matters',
Svg: require('@site/static/img/undraw_docusaurus_tree.svg').default,
title: 'Readable',
description: (
<>
Docusaurus lets you focus on your docs, and we&apos;ll do the chores. Go
ahead and move your docs into the <code>docs</code> directory.
Not just your source code is readable, it can also auto format the resulting code as well!
</>
),
},
{
title: 'Powered by React',
Svg: require('@site/static/img/undraw_docusaurus_react.svg').default,
title: 'Flexible',
description: (
<>
Extend or customize your website layout by reusing React. Docusaurus can
be extended while reusing the same header and footer.
Utilize variables and inline functions to create to create the most flexible stencils ever!
</>
),
},
];

function Feature({title, Svg, description}: FeatureItem) {
function Feature({title, description}: FeatureItem) {
return (
<div className={clsx('col col--4')}>
<div className={clsx('col col--4 padding-vert--lg')}>
<div className="text--center">
<Svg className={styles.featureSvg} role="img" />
{/*<Svg className={styles.featureSvg} role="img" />*/}
</div>
<div className="text--center padding-horiz--md">
<h3>{title}</h3>
Expand Down
4 changes: 2 additions & 2 deletions docs/src/css/custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

/* You can override the default Infima variables here. */
:root {
--ifm-color-primary: #2e8555;
--ifm-color-primary: rgb(89, 135, 104);
--ifm-color-primary-dark: #29784c;
--ifm-color-primary-darker: #277148;
--ifm-color-primary-darkest: #205d3b;
Expand All @@ -19,7 +19,7 @@

/* For readability concerns, you should choose a lighter palette in dark mode. */
[data-theme='dark'] {
--ifm-color-primary: #25c2a0;
--ifm-color-primary: rgb(89, 135, 104);
--ifm-color-primary-dark: #21af90;
--ifm-color-primary-darker: #1fa588;
--ifm-color-primary-darkest: #1a8870;
Expand Down
8 changes: 4 additions & 4 deletions docs/src/pages/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,13 @@ function HomepageHeader() {
return (
<header className={clsx('hero hero--primary', styles.heroBanner)}>
<div className="container">
<h1 className="hero__title">{siteConfig.title}</h1>
<h1 className="hero__title">{'Code Stencil'}</h1>
<p className="hero__subtitle">{siteConfig.tagline}</p>
<div className={styles.buttons}>
<Link
className="button button--secondary button--lg"
to="/docs/category/walkthrough">
Docusaurus Tutorial - 5min ⏱️
View Docs 📚
</Link>
</div>
</div>
Expand All @@ -32,8 +32,8 @@ export default function Home(): JSX.Element {
return (
<MDXContent>
<Layout
title={`Hello from ${siteConfig.title}`}
description="Description will go into a meta tag in <head />">
title={siteConfig.title}
description={siteConfig.tagline}>
<HomepageHeader />
<main>
<HomepageFeatures />
Expand Down
Binary file removed docs/static/img/docusaurus-social-card.jpg
Binary file not shown.
Binary file removed docs/static/img/docusaurus.png
Binary file not shown.
Binary file modified docs/static/img/favicon.ico
Binary file not shown.
Binary file added docs/static/img/icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 0 additions & 1 deletion docs/static/img/logo.svg

This file was deleted.

Binary file added docs/static/img/splash.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 23e083d

Please sign in to comment.