🔖 Documentation and Config prepared for release

This commit is contained in:
Miguel Avila 2022-02-14 13:47:02 -06:00
parent 024396bf30
commit fbf5bf843c
2 changed files with 28 additions and 31 deletions

View File

@ -16,8 +16,8 @@
- [👇 Index](#-index) - [👇 Index](#-index)
- [✨ Features](#-features) - [✨ Features](#-features)
- [🚀 Usage](#-usage) - [🚀 Usage](#-usage)
- [As Home Page](#as-home-page) - [🏡 As Home Page](#-as-home-page)
- [As New Tab](#as-new-tab) - [ As New Tab](#-as-new-tab)
- [🎨 Customization](#-customization) - [🎨 Customization](#-customization)
- [👋 General: Name, Image Background and Greetings](#-general-name-image-background-and-greetings) - [👋 General: Name, Image Background and Greetings](#-general-name-image-background-and-greetings)
- [📐 Layouts: Bento, Lists and Buttons.](#-layouts-bento-lists-and-buttons) - [📐 Layouts: Bento, Lists and Buttons.](#-layouts-bento-lists-and-buttons)
@ -31,26 +31,26 @@
## ✨ Features ## ✨ Features
- **Easy configuration** file. - **Easy configuration** file.
- **Dark/Light** mode, you can toggle them and It'll be saved in local storage.2 - **Dark/Light** mode, you can toggle it and will be saved in local storage.
- **Layouts!** to customize your experience following your workflow. - **Layouts!** to customize your experience following your workflow.
- **Clock and Date** format can be set to 24 hour (default) or 12 hour. - **Clock and Date** format can be set to 24 hour (default) or 12 hour.
- **Greetings** are easy to modify. - **Greetings** are easy to modify.
- **Variables** for custom colors and font sizes in the `style.css` code. - **Variables** for custom colors and font sizes in the `app.css` code.
- **Icons** all icons are from Feather Icons (Some others I made them with the Feather icons as a base) - **Icons** all icons are from [Lucide icons](https://lucide.dev).
- **Modular** javascript files for an easy read. - **Modular** javascript files for an easy read.
## 🚀 Usage ## 🚀 Usage
#### As Home Page ### 🏡 As Home Page
1. Fork this repo 1. Fork this repo
2. Enable the Github Pages service `Settings > GitHub Pages > Source [master branch] > Save` 2. Enable the Github Pages service `Settings → GitHub Pages → Source [master branch] → Save`
3. Set it as Home Page: 3. Set it as Home Page:
- Click the menu button. and select Options. Preferences. - Click the menu button. and select Options. Preferences.
- Click the Home panel. - Click the Home panel.
- Click the menu next to Homepage and new windows and choose to show custom URLs and add your `Github Pages link` - Click the menu next to Homepage and new windows and choose to show custom URLs and add your `Github Pages link`
#### As New Tab ### As New Tab
You can use different Add-ons/Extensions for it You can use different Add-ons/Extensions for it
@ -79,7 +79,7 @@ To change the default name, the greetings and if you want to have an image backg
``` ```
> You cah change the background by substituting the `background.jpg` file in `assets` folder. > You can change the background by substituting the `background.jpg` file in `assets` folder.
![](assets/img/backgroundImage.png) ![](assets/img/backgroundImage.png)

View File

@ -16,17 +16,17 @@ const CONFIG = {
openInNewTab: true, openInNewTab: true,
twelveHourFormat: false, twelveHourFormat: false,
// Layout
bentoLayout: 'bento', // 'bento', 'lists', 'buttons'
// Greetings // Greetings
greetingMorning: 'Good morning!', greetingMorning: 'Good morning!',
greetingAfternoon: 'Good afternoon,', greetingAfternoon: 'Good afternoon,',
greetingEvening: 'Good evening,', greetingEvening: 'Good evening,',
greetingNight: 'Go to Sleep!', greetingNight: 'Go to Sleep!',
// Layout
bentoLayout: 'bento', // 'bento', 'lists', 'buttons'
// Weather // Weather
weatherKey: '15fe26a8e22e4783054e3273824c5e7b', // Write here your API Key weatherKey: 'InsertYourAPIKeyHere123456', // Write here your API Key
weatherIcons: 'OneDark', // 'Onedark', 'Nord', 'Dark', 'White' weatherIcons: 'OneDark', // 'Onedark', 'Nord', 'Dark', 'White'
weatherUnit: 'C', // 'F', 'C' weatherUnit: 'C', // 'F', 'C'
language: 'en', // More languages in https://openweathermap.org/current#multi language: 'en', // More languages in https://openweathermap.org/current#multi
@ -39,16 +39,13 @@ const CONFIG = {
autoChangeTheme: true, autoChangeTheme: true,
// Autochabge by OS // Autochabge by OS
changeThemeByOS: false, changeThemeByOS: true,
// Autochange by hour options (24hrs format, string must be in: hh:mm) // Autochange by hour options (24hrs format, string must be in: hh:mm)
changeThemeByHour: true, changeThemeByHour: false,
hourDarkThemeActive: '18:30', hourDarkThemeActive: '18:30',
hourDarkThemeInactive: '07:00', hourDarkThemeInactive: '07:00',
// ╦ ╦╔╗╔╦╔═╔═╗
// ║ ║║║║╠╩╗╚═╗
// ╩═╝╩╝╚╝╩ ╩╚═╝
// ┌┐ ┬ ┬┌┬┐┌┬┐┌─┐┌┐┌┌─┐ // ┌┐ ┬ ┬┌┬┐┌┬┐┌─┐┌┐┌┌─┐
// ├┴┐│ │ │ │ │ ││││└─┐ // ├┴┐│ │ │ │ │ ││││└─┐
// └─┘└─┘ ┴ ┴ └─┘┘└┘└─┘ // └─┘└─┘ ┴ ┴ └─┘┘└┘└─┘
@ -165,19 +162,19 @@ const CONFIG = {
links: [ links: [
{ {
name: 'Linkedin', name: 'Linkedin',
link: 'https://www.youtube.com/watch?v=dQw4w9WgXcQ', link: 'https://www.linkedin.com',
}, },
{ {
name: 'Dribbble', name: 'Dribbble',
link: 'https://www.youtube.com/watch?v=dQw4w9WgXcQ', link: 'https://www.dribbble.com',
}, },
{ {
name: 'Trello', name: 'Trello',
link: 'https://www.youtube.com/watch?v=dQw4w9WgXcQ', link: 'https://www.trello.com',
}, },
{ {
name: 'Slack', name: 'Slack',
link: 'https://www.youtube.com/watch?v=dQw4w9WgXcQ', link: 'https://www.slack.com',
}, },
], ],
}, },
@ -191,19 +188,19 @@ const CONFIG = {
links: [ links: [
{ {
name: 'Spotify', name: 'Spotify',
link: 'https://www.youtube.com/watch?v=dQw4w9WgXcQ', link: 'https://www.spotify.com',
}, },
{ {
name: 'Reddit', name: 'Reddit',
link: 'https://www.youtube.com/watch?v=dQw4w9WgXcQ', link: 'https://www.reddit.com',
}, },
{ {
name: 'Hashnode', name: 'Hashnode',
link: 'https://www.youtube.com/watch?v=dQw4w9WgXcQ', link: 'https://www.hashnode.com',
}, },
{ {
name: 'Pocket', name: 'Pocket',
link: 'https://www.youtube.com/watch?v=dQw4w9WgXcQ', link: 'https://www.pocket.com',
}, },
], ],
}, },
@ -212,20 +209,20 @@ const CONFIG = {
id: '2', id: '2',
links: [ links: [
{ {
name: 'Web', name: 'Front',
link: 'https://www.youtube.com/watch?v=dQw4w9WgXcQ', link: 'https://www.reddit.com/r/Frontend/',
}, },
{ {
name: 'Rust', name: 'Rust',
link: 'https://www.youtube.com/watch?v=dQw4w9WgXcQ', link: 'https://www.reddit.com/r/rust/',
}, },
{ {
name: 'Go', name: 'Go',
link: 'https://www.youtube.com/watch?v=dQw4w9WgXcQ', link: 'https://www.reddit.com/r/golang/',
}, },
{ {
name: 'Repos', name: 'Repos',
link: 'https://www.youtube.com/watch?v=dQw4w9WgXcQ', link: 'https://github.com/migueravila,
}, },
], ],
}, },