diff --git a/docs/.vitepress/config.js b/docs/.vitepress/config.js index 9dd25073..2ae6e99c 100644 --- a/docs/.vitepress/config.js +++ b/docs/.vitepress/config.js @@ -1,11 +1,10 @@ import { version } from '../../package.json'; export default { - lang: 'en-US', - title: 'Muuri', - description: 'Build all kinds of layouts', + title: 'Muuri Docs', + description: 'Documentation for Muuri JavaScript library.', - head: [['link', { rel: 'icon', type: 'image/x-icon', href: '/favicon.ico' }]], + head: [['link', { rel: 'icon', type: 'image/svg+xml', href: '/muuri-icon.svg' }]], lastUpdated: true, @@ -13,7 +12,7 @@ export default { // cleanUrls: 'without-subfolders', themeConfig: { - logo: '/logo.svg', + logo: '/muuri-icon.svg', nav: nav(), @@ -22,17 +21,12 @@ export default { }, editLink: { - pattern: 'https://github.com/haltu/muuri/edit/main/docs/:path', + pattern: 'https://github.com/haltu/muuri/edit/master/docs/:path', text: 'Edit this page on GitHub', }, socialLinks: [{ icon: 'github', link: 'https://github.com/haltu/muuri' }], - footer: { - message: 'Released under the MIT License.', - copyright: 'Copyright © 2017-present Niklas Rämö', - }, - algolia: { appId: 'xxxxx', apiKey: 'xxxxx', @@ -48,12 +42,6 @@ export default { function nav() { return [ - { text: 'Docs', link: '/what-is-muuri', activeMatch: '/' }, - { - text: 'Examples', - link: '/examples', - activeMatch: '/examples', - }, { text: version, items: [ @@ -73,18 +61,16 @@ function nav() { function sidebarGuide() { return [ { - text: 'Introduction', - collapsible: true, + collapsible: false, items: [ - { text: 'What is Muuri?', link: '/' }, + { text: 'Introduction', link: '/' }, { text: 'Getting Started', link: '/getting-started' }, - { text: 'Motivation', link: '/motivation' }, - { text: 'Credits', link: '/credits' }, + { text: 'Examples', link: '/examples' }, ], }, { text: 'API', - collapsible: true, + collapsible: false, items: [ { text: 'Grid Constructor', link: '/grid-constructor' }, { text: 'Grid Options', link: '/grid-options' }, @@ -93,10 +79,5 @@ function sidebarGuide() { { text: 'Item Methods', link: '/item-methods' }, ], }, - { - text: 'Examples', - collapsible: true, - items: [{ text: 'Demos', link: '/examples' }], - }, ]; } diff --git a/docs/credits.md b/docs/credits.md deleted file mode 100644 index ccfbcc31..00000000 --- a/docs/credits.md +++ /dev/null @@ -1,8 +0,0 @@ -# Credits - -**Created and maintained by [Niklas Rämö](https://github.com/niklasramo).** - -- This project owes much to David DeSandro's [Masonry](http://masonry.desandro.com/), [Packery](http://packery.metafizzy.co/) and [Isotope](https://isotope.metafizzy.co/) libraries. You should go ahead and check them out right now if you haven't yet. Thanks Dave! -- Jukka Jylänki's [survey](https://github.com/juj/RectangleBinPack) "A Thousand Ways to Pack the Bin - A Practical Approach to Two-Dimensional Rectangle Bin Packing" came in handy when building Muuri's layout algorithms. Thanks Jukka! -- Big thanks to the people behind [Web Animations polyfill](https://github.com/web-animations/web-animations-js) for making it possible to use Web Animations API reliably across browsers today. -- [Haltu Oy](http://www.haltu.fi/) was responsible for initiating this project in the first place and funded the initial development. Thanks Haltu! diff --git a/docs/examples.md b/docs/examples.md index a4bcb053..dfca8404 100644 --- a/docs/examples.md +++ b/docs/examples.md @@ -2,7 +2,7 @@ ## Barebones Grid -