Skip to content

Commit

Permalink
feat: Better naming for folders and layouts while providing fallback,…
Browse files Browse the repository at this point in the history
… provide an folder for easy development and provide .npmignore

Right after the release... wow
  • Loading branch information
GabsEdits committed May 6, 2024
1 parent 8f77c45 commit 8f9d83d
Show file tree
Hide file tree
Showing 21 changed files with 1,763 additions and 19 deletions.
8 changes: 8 additions & 0 deletions .development/default/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"type": "module",
"dependencies": {
"aplos": "file:../.././",
"sass": "^1.74.1",
"vitepress": "^1.1.4"
}
}
95 changes: 95 additions & 0 deletions .development/default/pages/.vitepress/config.mts
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
import { defineConfig } from "vitepress";

// https://vitepress.dev/reference/site-config
export default defineConfig({
lang: "en-US",
title: "Aplós Nightly",
description:
"This is a cool template for VitePress, it has a lot of features, and it's easy to use",

lastUpdated: true,
cleanUrls: true,

themeConfig: { // Main Theme Config
author: "Your Name", // Change this to your name
colorScheme: {
accent: "#c1b134", // Change this to your accent color (Doesn't work currently, will be fixed in the future. For now, just change the color in the custom.scss file)
},
nav: {
links: [
{ text: "Guide", link: "https://aplos.gxbs.me/guide/" },
{ text: "Demo", link: "/demo" },
// To add more links, just add more objects to the array, with the text and link like so:
// { text: "Text (The text for the link)", link: "Link" },
],
git: "https://github.com/GabsEdits/aplos-template", // Link to the source code of your site, if your site isn't open source, you can remove this
},
footer: {
// To disable any of these, just set them to false, to enable them, set them to true
copyright: true,
poweredBy: true,

// To change the text of any of these, just change the text in the quotes, if you want to disable it entirely, set show to false
madeby: {
show: true,
name: "Your Name",
link: "https://yourwebsite.com",
},
},
},

markdown: {
container: {
warningLabel: "⚠ Warning",
tipLabel: "Tip",
dangerLabel: "⚠ Danger",
infoLabel: "Info",
},
},
head: [
["meta", { name: "author", content: "Your Name" }], // Change this to your name
["link", { rel: "icon", href: "/favicon.ico" }],
["meta", { name: "theme-color", content: "#ff3e00" }], // Your theme color
["meta", { name: "og:type", content: "website" }],
["meta", { name: "og:locale", content: "en" }],
["meta", { name: "og:site_name", content: "Template" }], // Change this to your site name
[
"meta",
{
name: "og:image",
content: "https://aplos.gxbs.me/images/aplos-banner.jpg", // Change this to your image
},
],
["meta", { name: "twitter:card", content: "summary_large_image" }],
[
"meta",
{
name: "twitter:image",
content: "https://aplos.gxbs.me/images/aplos-banner.jpg", // Change this to your image
},
],
["meta", { name: "twitter:title", content: "Aplós Template" }], // Change this to your title
[
"meta",
{
name: "twitter:description",
content: "Build an website fast, and easy", // Change this to your description
},
],
["meta", { name: "twitter:url", content: "https://aplos.gxbs.me" }], // Change this to your domain
],
sitemap: { // Change this to your domain
hostname: "https://template.aplos.gxbs.me",
},
vite: {
css: {
preprocessorOptions: {
scss: {
additionalData: `
$color-accent: #9eb036;
`,
},
},
},
},
});
7 changes: 7 additions & 0 deletions .development/default/pages/.vitepress/theme/custom.scss
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
#for-development {
text-align: center;
color: var(--color-text-secondary);
margin-top: 150px;
font-weight: 700;
letter-spacing: 10px;
}
8 changes: 8 additions & 0 deletions .development/default/pages/.vitepress/theme/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
import type { Theme } from "vitepress";
import Aplos from "aplos/minimal/Layout.vue";
import "aplos/minimal";
import "./custom.scss"

export default {
Layout: Aplos,
} satisfies Theme;
205 changes: 205 additions & 0 deletions .development/default/pages/demo.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,205 @@
---
layout: simple
---

# Demo

[[toc]]

Lorem ipsum dolor sit amet consectetur adipisicing elit. Nemo labore aperiam, asperiores doloribus earum qui id harum neque modi nostrum similique. Rerum consequatur ab eaque velit consequuntur blanditiis praesentium commodi.

Ullus investigandi veri, nisi inveneris, et quaerendi defatigatio turpis est, cum esset accusata et vituperata ab Hortensio. Qui liber cum et mortem contemnit, qua qui est imbutus quietus esse numquam potest. Praeterea bona praeterita.

Ullus investigandi veri, nisi inveneris, et quaerendi defatigatio turpis est, cum esset accusata et vituperata ab Hortensio. Qui liber cum et mortem contemnit, qua qui est imbutus quietus esse numquam potest. Praeterea bona praeterita grata recordatione renovata delectant. Est autem situm in nobis ut et voluptates et dolores nasci fatemur e corporis voluptatibus et doloribus -- itaque concedo, quod modo dicebas, cadere causa, si qui incurrunt, numquam vim tantam.

## Header 2

### Header 3

- Item 1
- Item 2
- Item 3
- `Item 4`

#### Header 4

##### Header 5

###### Header 6

> “Simplicity is the ultimate sophistication.”
>
> > — Leonardo da Vinci
## Syntax Highlighting

VitePress provides Syntax Highlighting powered by [Shiki](https://github.com/shikijs/shiki), with additional features like line-highlighting:

### Input

````md
```js{4}
export default {
data () {
return {
msg: 'Highlighted!'
}
}
}
```
````

### Output

```js{4}
export default {
data () {
return {
msg: 'Highlighted!'
}
}
}
```

## Photo & Video

[![A herd of sheep grazing on a lush green field](https://images.unsplash.com/photo-1713098564541-3e11d9898721?q=80&w=1932&auto=format&fit=crop&ixlib=rb-4.0.3&ixid=M3wxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8fA%3D%3D)](https://unsplash.com/photos/a-herd-of-sheep-grazing-on-a-lush-green-field-yB3YWgyQIk0)

<figcaption>A herd of sheep grazing on a lush green field</figcaption>

To write a caption to a photo use the `figcaption` tag:

```html
<figcaption>Wow</figcaption>
```

<video alt="Red flower wakes up" controls="" src="https://interactive-examples.mdn.mozilla.net/media/cc0-videos/flower.webm"></video>

<figcaption>An "interactive example" of a video called flower.webm from the MDN Docs</figcaption>

Text can be **bold**, _italic_, or strikethrough.

Also we have [Links](/)

We also have lines.

---

## Information boxes

Aplus has various types of information boxes.

- The `info` box provides general information.
- The `tip` box provides helpful tips.
- The `warning` box indicates potential issues or concerns.
- The `danger` box warns about dangerous situations.
- The `details` block provides additional details or explanations.

All of them can be applied using the following formula:

```md
::: name-of-the-box (info, tip, warning, danger, details)
The message you want to share
:::
```

### Input

```md
::: info
This is an info box.
:::

::: tip
This is a tip.
:::

::: warning
This is a warning.
:::

::: danger
This is a dangerous warning.
:::

::: details
This is a details block.
:::
```

### Output

::: info
This is an info box.
:::

::: tip
This is a tip.
:::

::: warning
This is a warning.
:::

::: danger
This is a dangerous warning.
:::

::: details
This is a details block.
:::

<kbd>⌘ Super</kbd> + <kbd>Space</kbd>

Use this when something is <mark>really important</mark>

## Table

| Syntax | Description |
| ------------ | ----------- |
| Header | Title |
| Paragraph | Text |
| Something | And wow |
| I don't know | And huh |

## Small Text

You can add small text by using the `<small>` tag.

### Input

```html
<small>Something Small</small>
```

### Output

<small>Something Small</small>

## Time

You can show a specific time by using the `<time>` tag:

#### Input

```html
<time>10:00</time>
```

#### Output

<time>10:00</time>

### Time Animation

You also can have an animation to the time like this one: <time>**11:00**</time>

#### Input

```md
<time>**11:00**</time>
```

#### Output

<time>**11:00**</time>
7 changes: 7 additions & 0 deletions .development/default/pages/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Aplós Nightly

This is used for development purposes only, to only check if the changes are working as expected.

**See [Demo](./demo.md) to see if everything is working as expected.**

For Development {#for-development}
Binary file added .development/default/pages/public/favicon.ico
Binary file not shown.
Loading

0 comments on commit 8f9d83d

Please sign in to comment.