tomasalias/AstralRinth
1
0
Fork 0
forked from didirus/AstralRinth
Code Pull Requests Activity

Move fonts folder + Update setup docs for Vite

Browse Source
This commit is contained in:
venashial
2022-07-28 23:34:43 -07:00
parent fa3cbbee67
commit e73b6bc39e
7 changed files with 44 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/app.html
View File

@@ -3,7 +3,7 @@
<head> <head>
<meta charset="utf-8" /> <meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" /> <meta name="viewport" content="width=device-width, initial-scale=1" />
<link rel="icon" href="%sveltekit.assets%/assets/omorphia.png" /> <link rel="icon" href="%sveltekit.assets%/omorphia.png" />
<link <link
rel="preload" rel="preload"
@@ -26,7 +26,7 @@
<meta name="theme-color" content="#CF1971" /> <meta name="theme-color" content="#CF1971" />
<meta name="twitter:card" content="summary" /> <meta name="twitter:card" content="summary" />
<meta name="twitter:image" content="https://omorphia.modrinth.com/assets/omorphia.png" /> <meta name="twitter:image" content="https://omorphia.modrinth.com/omorphia.png" />
<meta property="og:site_name" content="Modrinth" /> <meta property="og:site_name" content="Modrinth" />
%sveltekit.head% %sveltekit.head%

67
docs/routes/setup.md
View File

@@ -66,9 +66,7 @@ Add the following parts to your `svelte.config.js` file:
```js ```js
import adapter from '@sveltejs/adapter-auto' import adapter from '@sveltejs/adapter-auto'
import { preprocess, plugins } from 'omorphia/config/svelte' import { preprocess } from 'omorphia/config/svelte'
import precompileIntl from 'svelte-intl-precompile/sveltekit-plugin'
import { Generator } from 'omorphia/plugins'
import path from 'path' import path from 'path'
/** @type {import('@sveltejs/kit').Config} */ /** @type {import('@sveltejs/kit').Config} */
@@ -82,24 +80,6 @@ const config = {
$generated: path.resolve('./generated'), $generated: path.resolve('./generated'),
$stores: path.resolve('./src/stores'), $stores: path.resolve('./src/stores'),
}, },
vite: {
plugins: [
...plugins,
precompileIntl('locales'),
Generator({
gameVersions: true,
openapi: true,
// Add more if needed
}),
],
server: {
fs: {
allow: ['generated'],
},
},
},
}, },
} }
@@ -114,7 +94,38 @@ import { writable } from 'svelte/store'
export const token = writable('') export const token = writable('')
``` ```
## `5.` Configure PostCSS ## `5.` Configure Vite
Add the following to your `vite.config.js` file:
```js
import { plugins } from 'omorphia/config/vite.js'
import { Generator } from 'omorphia/plugins'
import precompileIntl from 'svelte-intl-precompile/sveltekit-plugin'
/** @type {import('vite').UserConfig} */
const config = {
plugins: [
...plugins,
precompileIntl('locales'),
Generator({
gameVersions: true,
openapi: true,
// Add more if needed
}),
],
server: {
fs: {
allow: ['generated'],
},
},
}
export default config
```
## `6.` Configure PostCSS
Create a `postcss.config.cjs` file in the root of your project. Create a `postcss.config.cjs` file in the root of your project.
@@ -124,7 +135,7 @@ Add the following line to that file:
module.exports = require('omorphia/config/postcss.cjs') module.exports = require('omorphia/config/postcss.cjs')
``` ```
## `6.` Setup styles ## `7.` Setup styles
Import styles in `src/routes/__layout.svelte`: Import styles in `src/routes/__layout.svelte`:
@@ -142,7 +153,7 @@ Add the `base` class and a theme to the `<body>` tag in `src/app.html`:
</body> </body>
``` ```
## `7.` Setup fonts ## `8.` Setup fonts
Copy the the `fonts/` folder from [Omorphia's repository](https://github.com/modrinth/omorphia/blob/main/docs/static/assets/fonts) and place them in the `static/` folder at the root of your project. Copy the the `fonts/` folder from [Omorphia's repository](https://github.com/modrinth/omorphia/blob/main/docs/static/assets/fonts) and place them in the `static/` folder at the root of your project.
@@ -151,14 +162,14 @@ Add the following preload tags to your head in `app.html` to speed up font loadi
<!-- prettier-ignore-start --> <!-- prettier-ignore-start -->
```html ```html
<head> <head>
<link rel="preload" href="/assets/fonts/InterRegular.woff2" as="font" type="font/woff2" crossorigin> <link rel="preload" href="/fonts/InterRegular.woff2" as="font" type="font/woff2" crossorigin>
<link rel="preload" href="/assets/fonts/InterBold.woff2" as="font" type="font/woff2" crossorigin> <link rel="preload" href="/fonts/InterBold.woff2" as="font" type="font/woff2" crossorigin>
<link rel="preload" href="/assets/fonts/InterSemiBold.woff2" as="font" type="font/woff2" crossorigin> <link rel="preload" href="/fonts/InterSemiBold.woff2" as="font" type="font/woff2" crossorigin>
</head> </head>
``` ```
<!-- prettier-ignore-end --> <!-- prettier-ignore-end -->
## `8.` Using Omorphia ## `9.` Using Omorphia
### Developing ### Developing

0
docs/static/assets/fonts/InterBold.woff2 → docs/static/fonts/InterBold.woff2 vendored
View File

0
docs/static/assets/fonts/InterRegular.woff2 → docs/static/fonts/InterRegular.woff2 vendored
View File

0
docs/static/assets/fonts/InterSemiBold.woff2 → docs/static/fonts/InterSemiBold.woff2 vendored
View File

0
docs/static/assets/omorphia.png → docs/static/omorphia.png vendored
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 15 KiB

After

Width:  |  Height:  |  Size: 15 KiB

6
src/styles/variables/typography.postcss
View File

@@ -25,7 +25,7 @@
font-style: normal; font-style: normal;
font-weight: 400; font-weight: 400;
font-display: fallback; font-display: fallback;
src: local(''), url('/assets/fonts/InterRegular.woff2') format('woff2'); src: local(''), url('/fonts/InterRegular.woff2') format('woff2');
} }
/* inter-600 - latin */ /* inter-600 - latin */
@@ -34,7 +34,7 @@
font-style: normal; font-style: normal;
font-weight: 600; font-weight: 600;
font-display: fallback; font-display: fallback;
src: local(''), url('/assets/fonts/InterSemiBold.woff2') format('woff2'); src: local(''), url('/fonts/InterSemiBold.woff2') format('woff2');
} }
/* inter-700 - latin */ /* inter-700 - latin */
@@ -43,6 +43,6 @@
font-style: normal; font-style: normal;
font-weight: 700; font-weight: 700;
font-display: fallback; font-display: fallback;
src: local(''), url('/assets/fonts/InterBold.woff2') format('woff2'); src: local(''), url('/fonts/InterBold.woff2') format('woff2');
} }
} }