Skip to content

Commit

Permalink
let there be light
Browse files Browse the repository at this point in the history
  • Loading branch information
gabrielmeloc22 committed Oct 17, 2024
0 parents commit acc4752
Show file tree
Hide file tree
Showing 42 changed files with 20,232 additions and 0 deletions.
4 changes: 4 additions & 0 deletions .eslintignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
.vscode/
dist/
node_modules/
public/
32 changes: 32 additions & 0 deletions .eslintrc.cjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
module.exports = {
env: {
node: true,
browser: true,
es2024: true,
},
extends: [
"eslint:recommended",
"plugin:astro/recommended",
"plugin:@typescript-eslint/recommended",
],
parserOptions: {
ecmaVersion: "latest",
sourceType: "module",
},
rules: {
semi: ["error", "always"],
quotes: ["error", "double", { "allowTemplateLiterals": true }],
"@typescript-eslint/triple-slash-reference": "off",
},
overrides: [
{
files: ["*.astro"],
parser: "astro-eslint-parser",
parserOptions: {
parser: "@typescript-eslint/parser",
extraFileExtensions: [".astro"],
},
rules: {},
},
],
};
22 changes: 22 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# build output
dist/

# generated types
.astro/

# dependencies
node_modules/

# logs
npm-debug.log*
yarn-debug.log*
yarn-error.log*
pnpm-debug.log*


# environment variables
.env
.env.production

# macOS-specific files
.DS_Store
4 changes: 4 additions & 0 deletions .vscode/extensions.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"recommendations": ["astro-build.astro-vscode", "unifiedjs.vscode-mdx"],
"unwantedRecommendations": []
}
11 changes: 11 additions & 0 deletions .vscode/launch.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"version": "0.2.0",
"configurations": [
{
"command": "./node_modules/.bin/astro dev",
"name": "Development server",
"request": "launch",
"type": "node-terminal"
}
]
}
64 changes: 64 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
![Astro Nano](_astro_nano.png)

Astro Nano is a static, minimalist, lightweight, lightning fast portfolio and blog theme.

Built with Astro, Tailwind and Typescript, an no frameworks.

It was designed as an even more minimal theme than my popular theme [Astro Sphere](https://github.com/markhorn-dev/astro-sphere)

## πŸš€ Deploy your own

[![Deploy with Vercel](_deploy_vercel.svg)](https://vercel.com/new/clone?repository-url=https://github.com/markhorn-dev/astro-nano) [![Deploy with Netlify](_deploy_netlify.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/markhorn-dev/astro-nano)

## πŸ“‹ Features

- βœ… 100/100 Lighthouse performance
- βœ… Responsive
- βœ… Accessible
- βœ… SEO-friendly
- βœ… Typesafe
- βœ… Minimal style
- βœ… Light/Dark Theme
- βœ… Animated UI
- βœ… Tailwind styling
- βœ… Auto generated sitemap
- βœ… Auto generated RSS Feed
- βœ… Markdown support
- βœ… MDX Support (components in your markdown)

## πŸ’― Lighthouse score
![Astro Nano Lighthouse Score](_lighthouse.png)

## πŸ•ŠοΈ Lightweight
No frameworks or added bulk

## ⚑︎ Fast
Rendered in ~40ms on localhost

## πŸ“„ Configuration

The blog posts on the demo serve as the documentation and configuration.

## πŸ’» Commands

All commands are run from the root of the project, from a terminal:

Replace npm with your package manager of choice. `npm`, `pnpm`, `yarn`, `bun`, etc

| Command | Action |
| :------------------------ | :----------------------------------------------- |
| `npm install` | Installs dependencies |
| `npm run dev` | Starts local dev server at `localhost:4321` |
| `npm run dev:network` | Starts local dev server on local network |
| `npm run sync` | Generates TypeScript types for all Astro modules.|
| `npm run build` | Build your production site to `./dist/` |
| `npm run preview` | Preview your build locally, before deploying |
| `npm run preview:network` | Preview build on local network |
| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
| `npm run astro -- --help` | Get help using the Astro CLI |
| `npm run lint` | Run ESLint |
| `npm run lint:fix` | Auto-fix ESLint issues |

## πŸ›οΈ License

MIT
10 changes: 10 additions & 0 deletions astro.config.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
// @ts-check
import { defineConfig } from "astro/config";
import mdx from "@astrojs/mdx";
import sitemap from "@astrojs/sitemap";
import tailwind from "@astrojs/tailwind";

export default defineConfig({
site: "https://astro-nano-demo.vercel.app",
integrations: [mdx(), sitemap(), tailwind()],
});
Loading

0 comments on commit acc4752

Please sign in to comment.