Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Latest Blog: Updated the script and made a shell script in the APX Repo #104

Open
wants to merge 14 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 0 additions & 34 deletions .github/workflows/contributors.yml

This file was deleted.

34 changes: 31 additions & 3 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,31 @@
/assets/images/*.gvdesign
/_site
.jekyll-cache
# Logs
logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*
pnpm-debug.log*
lerna-debug.log*

node_modules
.DS_Store
dist
dist-ssr
coverage
*.local

/cypress/videos/
/cypress/screenshots/

/public/articles/
/public/articles.json

# Editor directories and files
.vscode/*
!.vscode/extensions.json
.idea
*.suo
*.ntvs*
*.njsproj
*.sln
*.sw?
4 changes: 4 additions & 0 deletions .prettierrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"tabWidth": 2,
"useTabs": false
}
3 changes: 3 additions & 0 deletions .vscode/extensions.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"recommendations": ["Vue.volar", "Vue.vscode-typescript-vue-plugin"]
}
1 change: 0 additions & 1 deletion CNAME

This file was deleted.

2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
Expand Up @@ -658,4 +658,4 @@ specific requirements.
You should also get your employer (if you work as a programmer) or school,
if any, to sign a "copyright disclaimer" for the program, if necessary.
For more information on this, and how to apply and follow the GNU AGPL, see
<https://www.gnu.org/licenses/>.
<https://www.gnu.org/licenses/>.
75 changes: 64 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,77 @@
<div align="center">
<img src="assets/dark.png?raw=true#gh-dark-mode-only" height="40">
<img src="assets/light.png?raw=true#gh-light-mode-only" height="40">
<img src="logo-white.png?raw=true#gh-dark-mode-only" height="40">
<img src="logo.png?raw=true#gh-light-mode-only" height="40">
<hr />
<p>This page contains source code of the official Vanilla OS website.</p>
<p>This source code is distributed under the <a href="LICENSE">AGPL 3.0</a>
license, while Vanilla OS is a product of <a href="//fabricators.ltd" target="_blank">fabricators.ltd</a>.
Please note that all assets on this website are owned by fabricators.ltd and
the Vanilla OS Contributors Team.</p>
</div>

## Development

To run the Vanilla OS website locally, install [Jekyll](https://jekyllrb.com/docs/), the required plugins and clone this repository:
### CSS Convention

Our framework follows the [BEM (Block, Element, Modifier)](https://en.bem.info/methodology/quick-start/)
convention for CSS classes.

Colors are defined in the `assets/css/colors/default.css` and `assets/css/colors/dark.css`
files, they must be unique and not overlap with each other.

Each new component (block) must be defined in a separate file in the `assets/css/components`
directory and must follow the following structure:

```css
.block {
/* Color Variables */
--block-color: var(--color-primary);
--block-element-color: var(--color-secondary);
}

.block {
/* Block Styles */
background-color: var(--block-color);
}

.block-element {
/* Element Styles */
background-color: var(--block-element-color);
width: 100px;
height: 100px;
}

.block--modifier {
/* Modifier Styles */
width: 200px;
height: 200px;
}

/* Media Queries */
```

### Build and Run

To run the Vanilla OS website locally, you need to have [Vue.js](https://vuejs.org/) and
[Vite](https://vitejs.dev/) installed.

#### Build articles index

```bash
# make sure to have the requirements for jekyll installed: Ruby, RubyGems, GCC, Make
gem install jekyll bundler
gem install jekyll-feed jekyll-sitemap
git clone https://github.com/Vanilla-OS/website.git
cd website
npm run generate-articles
```

Then serve the site locally with:
#### Run the website locally

This will also build the articles index.

```bash
npm run dev
```

## Production Build

This will also build the articles index.

```bash
jekyll serve
npm run build
```
17 changes: 0 additions & 17 deletions _config.yml

This file was deleted.

9 changes: 0 additions & 9 deletions _includes/accordion-item.html

This file was deleted.

70 changes: 0 additions & 70 deletions _includes/footer.html

This file was deleted.

5 changes: 0 additions & 5 deletions _includes/head.html

This file was deleted.

29 changes: 0 additions & 29 deletions _includes/header.html

This file was deleted.

23 changes: 0 additions & 23 deletions _includes/posts-listing.html

This file was deleted.

23 changes: 0 additions & 23 deletions _layouts/article.html

This file was deleted.

19 changes: 0 additions & 19 deletions _layouts/default.html

This file was deleted.

Loading