Skip to content

Commit

Permalink
Make clean urls in docs, add blockquotes to README.md.
Browse files Browse the repository at this point in the history
  • Loading branch information
somespecialone committed Dec 7, 2023
1 parent 118212d commit 06e36f0
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 7 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,10 @@ precious [Locomotive Scroll](https://github.com/locomotivemtl/locomotive-scroll)

---

⚠️ The project is unstable and depends
on [Locomotive Scroll v5 beta](https://github.com/locomotivemtl/locomotive-scroll/tree/v5-beta).
So there might be some breaking changes in the future unless stable (first major) version is released. Best regards!
> [!WARNING]
> The project is unstable and depends
> on [Locomotive Scroll v5 beta](https://github.com/locomotivemtl/locomotive-scroll/tree/v5-beta).
> So there might be some breaking changes in the future unless stable (first major) version is released. Best regards!
---

Expand Down Expand Up @@ -140,6 +141,7 @@ function handleClickOnSomeElement({target}) {
attributes from [Locomotive Scroll element](https://scroll.locomotive.ca/docs/#/attributes).
* `usePotiah` - composable that returns current `Potiah` instance, `scrollTo` function, refs with scroll data.

> [!TIP]
> For more information please visit [Documentation 📖](https://potiah.somespecial.one)
## Credits:
Expand Down
6 changes: 2 additions & 4 deletions docs/.vitepress/config.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
import { defineConfig } from 'vitepress'

// @ts-ignore
import pkg from '../../lib/package.json'

export default defineConfig({
Expand Down Expand Up @@ -55,7 +54,6 @@ export default defineConfig({
}
},
markdown: { theme: { light: 'material-theme-lighter', dark: 'material-theme-darker' } },
sitemap: {
hostname: 'https://potiah.somespecialone.one'
}
sitemap: { hostname: 'https://potiah.somespecialone.one' },
cleanUrls: true
})

0 comments on commit 06e36f0

Please sign in to comment.