├── .gitattributes ├── LICENCE ├── README.md ├── favicon.svg ├── index.html ├── main.css └── main.js /.gitattributes: -------------------------------------------------------------------------------- 1 | # Auto detect text files and perform LF normalization 2 | * text=auto 3 | -------------------------------------------------------------------------------- /LICENCE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 2, June 1991 3 | 4 | Copyright (C) 1989, 1991 Free Software Foundation, Inc., 5 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 6 | Everyone is permitted to copy and distribute verbatim copies 7 | of this license document, but changing it is not allowed. 8 | 9 | Preamble 10 | 11 | The licenses for most software are designed to take away your 12 | freedom to share and change it. By contrast, the GNU General Public 13 | License is intended to guarantee your freedom to share and change free 14 | software--to make sure the software is free for all its users. This 15 | General Public License applies to most of the Free Software 16 | Foundation's software and to any other program whose authors commit to 17 | using it. (Some other Free Software Foundation software is covered by 18 | the GNU Lesser General Public License instead.) You can apply it to 19 | your programs, too. 20 | 21 | When we speak of free software, we are referring to freedom, not 22 | price. Our General Public Licenses are designed to make sure that you 23 | have the freedom to distribute copies of free software (and charge for 24 | this service if you wish), that you receive source code or can get it 25 | if you want it, that you can change the software or use pieces of it 26 | in new free programs; and that you know you can do these things. 27 | 28 | To protect your rights, we need to make restrictions that forbid 29 | anyone to deny you these rights or to ask you to surrender the rights. 30 | These restrictions translate to certain responsibilities for you if you 31 | distribute copies of the software, or if you modify it. 32 | 33 | For example, if you distribute copies of such a program, whether 34 | gratis or for a fee, you must give the recipients all the rights that 35 | you have. You must make sure that they, too, receive or can get the 36 | source code. And you must show them these terms so they know their 37 | rights. 38 | 39 | We protect your rights with two steps: (1) copyright the software, and 40 | (2) offer you this license which gives you legal permission to copy, 41 | distribute and/or modify the software. 42 | 43 | Also, for each author's protection and ours, we want to make certain 44 | that everyone understands that there is no warranty for this free 45 | software. If the software is modified by someone else and passed on, we 46 | want its recipients to know that what they have is not the original, so 47 | that any problems introduced by others will not reflect on the original 48 | authors' reputations. 49 | 50 | Finally, any free program is threatened constantly by software 51 | patents. We wish to avoid the danger that redistributors of a free 52 | program will individually obtain patent licenses, in effect making the 53 | program proprietary. To prevent this, we have made it clear that any 54 | patent must be licensed for everyone's free use or not licensed at all. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | GNU GENERAL PUBLIC LICENSE 60 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 61 | 62 | 0. This License applies to any program or other work which contains 63 | a notice placed by the copyright holder saying it may be distributed 64 | under the terms of this General Public License. The "Program", below, 65 | refers to any such program or work, and a "work based on the Program" 66 | means either the Program or any derivative work under copyright law: 67 | that is to say, a work containing the Program or a portion of it, 68 | either verbatim or with modifications and/or translated into another 69 | language. (Hereinafter, translation is included without limitation in 70 | the term "modification".) Each licensee is addressed as "you". 71 | 72 | Activities other than copying, distribution and modification are not 73 | covered by this License; they are outside its scope. The act of 74 | running the Program is not restricted, and the output from the Program 75 | is covered only if its contents constitute a work based on the 76 | Program (independent of having been made by running the Program). 77 | Whether that is true depends on what the Program does. 78 | 79 | 1. You may copy and distribute verbatim copies of the Program's 80 | source code as you receive it, in any medium, provided that you 81 | conspicuously and appropriately publish on each copy an appropriate 82 | copyright notice and disclaimer of warranty; keep intact all the 83 | notices that refer to this License and to the absence of any warranty; 84 | and give any other recipients of the Program a copy of this License 85 | along with the Program. 86 | 87 | You may charge a fee for the physical act of transferring a copy, and 88 | you may at your option offer warranty protection in exchange for a fee. 89 | 90 | 2. You may modify your copy or copies of the Program or any portion 91 | of it, thus forming a work based on the Program, and copy and 92 | distribute such modifications or work under the terms of Section 1 93 | above, provided that you also meet all of these conditions: 94 | 95 | a) You must cause the modified files to carry prominent notices 96 | stating that you changed the files and the date of any change. 97 | 98 | b) You must cause any work that you distribute or publish, that in 99 | whole or in part contains or is derived from the Program or any 100 | part thereof, to be licensed as a whole at no charge to all third 101 | parties under the terms of this License. 102 | 103 | c) If the modified program normally reads commands interactively 104 | when run, you must cause it, when started running for such 105 | interactive use in the most ordinary way, to print or display an 106 | announcement including an appropriate copyright notice and a 107 | notice that there is no warranty (or else, saying that you provide 108 | a warranty) and that users may redistribute the program under 109 | these conditions, and telling the user how to view a copy of this 110 | License. (Exception: if the Program itself is interactive but 111 | does not normally print such an announcement, your work based on 112 | the Program is not required to print an announcement.) 113 | 114 | These requirements apply to the modified work as a whole. If 115 | identifiable sections of that work are not derived from the Program, 116 | and can be reasonably considered independent and separate works in 117 | themselves, then this License, and its terms, do not apply to those 118 | sections when you distribute them as separate works. But when you 119 | distribute the same sections as part of a whole which is a work based 120 | on the Program, the distribution of the whole must be on the terms of 121 | this License, whose permissions for other licensees extend to the 122 | entire whole, and thus to each and every part regardless of who wrote it. 123 | 124 | Thus, it is not the intent of this section to claim rights or contest 125 | your rights to work written entirely by you; rather, the intent is to 126 | exercise the right to control the distribution of derivative or 127 | collective works based on the Program. 128 | 129 | In addition, mere aggregation of another work not based on the Program 130 | with the Program (or with a work based on the Program) on a volume of 131 | a storage or distribution medium does not bring the other work under 132 | the scope of this License. 133 | 134 | 3. You may copy and distribute the Program (or a work based on it, 135 | under Section 2) in object code or executable form under the terms of 136 | Sections 1 and 2 above provided that you also do one of the following: 137 | 138 | a) Accompany it with the complete corresponding machine-readable 139 | source code, which must be distributed under the terms of Sections 140 | 1 and 2 above on a medium customarily used for software interchange; or, 141 | 142 | b) Accompany it with a written offer, valid for at least three 143 | years, to give any third party, for a charge no more than your 144 | cost of physically performing source distribution, a complete 145 | machine-readable copy of the corresponding source code, to be 146 | distributed under the terms of Sections 1 and 2 above on a medium 147 | customarily used for software interchange; or, 148 | 149 | c) Accompany it with the information you received as to the offer 150 | to distribute corresponding source code. (This alternative is 151 | allowed only for noncommercial distribution and only if you 152 | received the program in object code or executable form with such 153 | an offer, in accord with Subsection b above.) 154 | 155 | The source code for a work means the preferred form of the work for 156 | making modifications to it. For an executable work, complete source 157 | code means all the source code for all modules it contains, plus any 158 | associated interface definition files, plus the scripts used to 159 | control compilation and installation of the executable. However, as a 160 | special exception, the source code distributed need not include 161 | anything that is normally distributed (in either source or binary 162 | form) with the major components (compiler, kernel, and so on) of the 163 | operating system on which the executable runs, unless that component 164 | itself accompanies the executable. 165 | 166 | If distribution of executable or object code is made by offering 167 | access to copy from a designated place, then offering equivalent 168 | access to copy the source code from the same place counts as 169 | distribution of the source code, even though third parties are not 170 | compelled to copy the source along with the object code. 171 | 172 | 4. You may not copy, modify, sublicense, or distribute the Program 173 | except as expressly provided under this License. Any attempt 174 | otherwise to copy, modify, sublicense or distribute the Program is 175 | void, and will automatically terminate your rights under this License. 176 | However, parties who have received copies, or rights, from you under 177 | this License will not have their licenses terminated so long as such 178 | parties remain in full compliance. 179 | 180 | 5. You are not required to accept this License, since you have not 181 | signed it. However, nothing else grants you permission to modify or 182 | distribute the Program or its derivative works. These actions are 183 | prohibited by law if you do not accept this License. Therefore, by 184 | modifying or distributing the Program (or any work based on the 185 | Program), you indicate your acceptance of this License to do so, and 186 | all its terms and conditions for copying, distributing or modifying 187 | the Program or works based on it. 188 | 189 | 6. Each time you redistribute the Program (or any work based on the 190 | Program), the recipient automatically receives a license from the 191 | original licensor to copy, distribute or modify the Program subject to 192 | these terms and conditions. You may not impose any further 193 | restrictions on the recipients' exercise of the rights granted herein. 194 | You are not responsible for enforcing compliance by third parties to 195 | this License. 196 | 197 | 7. If, as a consequence of a court judgment or allegation of patent 198 | infringement or for any other reason (not limited to patent issues), 199 | conditions are imposed on you (whether by court order, agreement or 200 | otherwise) that contradict the conditions of this License, they do not 201 | excuse you from the conditions of this License. If you cannot 202 | distribute so as to satisfy simultaneously your obligations under this 203 | License and any other pertinent obligations, then as a consequence you 204 | may not distribute the Program at all. For example, if a patent 205 | license would not permit royalty-free redistribution of the Program by 206 | all those who receive copies directly or indirectly through you, then 207 | the only way you could satisfy both it and this License would be to 208 | refrain entirely from distribution of the Program. 209 | 210 | If any portion of this section is held invalid or unenforceable under 211 | any particular circumstance, the balance of the section is intended to 212 | apply and the section as a whole is intended to apply in other 213 | circumstances. 214 | 215 | It is not the purpose of this section to induce you to infringe any 216 | patents or other property right claims or to contest validity of any 217 | such claims; this section has the sole purpose of protecting the 218 | integrity of the free software distribution system, which is 219 | implemented by public license practices. Many people have made 220 | generous contributions to the wide range of software distributed 221 | through that system in reliance on consistent application of that 222 | system; it is up to the author/donor to decide if he or she is willing 223 | to distribute software through any other system and a licensee cannot 224 | impose that choice. 225 | 226 | This section is intended to make thoroughly clear what is believed to 227 | be a consequence of the rest of this License. 228 | 229 | 8. If the distribution and/or use of the Program is restricted in 230 | certain countries either by patents or by copyrighted interfaces, the 231 | original copyright holder who places the Program under this License 232 | may add an explicit geographical distribution limitation excluding 233 | those countries, so that distribution is permitted only in or among 234 | countries not thus excluded. In such case, this License incorporates 235 | the limitation as if written in the body of this License. 236 | 237 | 9. The Free Software Foundation may publish revised and/or new versions 238 | of the General Public License from time to time. Such new versions will 239 | be similar in spirit to the present version, but may differ in detail to 240 | address new problems or concerns. 241 | 242 | Each version is given a distinguishing version number. If the Program 243 | specifies a version number of this License which applies to it and "any 244 | later version", you have the option of following the terms and conditions 245 | either of that version or of any later version published by the Free 246 | Software Foundation. If the Program does not specify a version number of 247 | this License, you may choose any version ever published by the Free Software 248 | Foundation. 249 | 250 | 10. If you wish to incorporate parts of the Program into other free 251 | programs whose distribution conditions are different, write to the author 252 | to ask for permission. For software which is copyrighted by the Free 253 | Software Foundation, write to the Free Software Foundation; we sometimes 254 | make exceptions for this. Our decision will be guided by the two goals 255 | of preserving the free status of all derivatives of our free software and 256 | of promoting the sharing and reuse of software generally. 257 | 258 | NO WARRANTY 259 | 260 | 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY 261 | FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN 262 | OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES 263 | PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED 264 | OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 265 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS 266 | TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE 267 | PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, 268 | REPAIR OR CORRECTION. 269 | 270 | 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 271 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR 272 | REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, 273 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING 274 | OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED 275 | TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY 276 | YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER 277 | PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE 278 | POSSIBILITY OF SUCH DAMAGES. 279 | 280 | END OF TERMS AND CONDITIONS 281 | 282 | How to Apply These Terms to Your New Programs 283 | 284 | If you develop a new program, and you want it to be of the greatest 285 | possible use to the public, the best way to achieve this is to make it 286 | free software which everyone can redistribute and change under these terms. 287 | 288 | To do so, attach the following notices to the program. It is safest 289 | to attach them to the start of each source file to most effectively 290 | convey the exclusion of warranty; and each file should have at least 291 | the "copyright" line and a pointer to where the full notice is found. 292 | 293 | 294 | Copyright (C) 295 | 296 | This program is free software; you can redistribute it and/or modify 297 | it under the terms of the GNU General Public License as published by 298 | the Free Software Foundation; either version 2 of the License, or 299 | (at your option) any later version. 300 | 301 | This program is distributed in the hope that it will be useful, 302 | but WITHOUT ANY WARRANTY; without even the implied warranty of 303 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 304 | GNU General Public License for more details. 305 | 306 | You should have received a copy of the GNU General Public License along 307 | with this program; if not, write to the Free Software Foundation, Inc., 308 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 309 | 310 | Also add information on how to contact you by electronic and paper mail. 311 | 312 | If the program is interactive, make it output a short notice like this 313 | when it starts in an interactive mode: 314 | 315 | Gnomovision version 69, Copyright (C) year name of author 316 | Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 317 | This is free software, and you are welcome to redistribute it 318 | under certain conditions; type `show c' for details. 319 | 320 | The hypothetical commands `show w' and `show c' should show the appropriate 321 | parts of the General Public License. Of course, the commands you use may 322 | be called something other than `show w' and `show c'; they could even be 323 | mouse-clicks or menu items--whatever suits your program. 324 | 325 | You should also get your employer (if you work as a programmer) or your 326 | school, if any, to sign a "copyright disclaimer" for the program, if 327 | necessary. Here is a sample; alter the names: 328 | 329 | Yoyodyne, Inc., hereby disclaims all copyright interest in the program 330 | `Gnomovision' (which makes passes at compilers) written by James Hacker. 331 | 332 | , 1 April 1989 333 | Ty Coon, President of Vice 334 | 335 | This General Public License does not permit incorporating your program into 336 | proprietary programs. If your program is a subroutine library, you may 337 | consider it more useful to permit linking proprietary applications with the 338 | library. If this is what you want to do, use the GNU Lesser General 339 | Public License instead of this License. 340 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 |
2 | Logo 3 |
4 |

Shelf

5 |

A fully customisable, open-source browser startpage, built with vanilla HTML.

6 | 7 |
8 |
9 |
10 | 11 | # Content 12 | 13 | - [Motivation](#motivation) 14 | - [Getting Started](#getting-started) 15 | - [Documentation](#documentation) 16 | - [Colour](#colour) 17 | - [Clock](#clock) 18 | - [Searchbar](#searchbar) 19 | - [Change Search Engine](#change-search-engine) 20 | - [Change Layout](#change-layout) 21 | - [Delete](#delete) 22 | - [Layout](#layout) 23 | - [Change Height of Links](#change-height-of-links) 24 | - [Change Links to be the Same Height](#change-links-to-be-the-same-height) 25 | - [Content](#content) 26 | - [Links](#links) 27 | - [Headings](#headings) 28 | - [Contributing](#contributing) 29 | - [Forking Guidelines & License Notice](#forking-guidelines--license-notice) 30 | 31 |
32 |
33 |
34 | 35 | # Motivation 36 | 37 | I created Shelf because I wanted a locally-accessible browser startpage that enabled me to organise my bookmarks by relative size - to represent importance and to increase ease-of-access to the places I visit the most (also, I just wanted to experiment with some cool gradient designs). Additionally, I wanted my searchbar to be focused when the browser loads, to start searching as soon as it opens (without having to click on any input fields, because after all, if you're not clicking on a bookmark, you're probably opening your browser to search something up). 38 | 39 | I like to use Shelf by keeping my most visited and important bookmarks as the largest link elements, whilst having the clock and searchbar right above them, for quick access. 40 | 41 |
42 |
43 |
44 | 45 | # Getting Started 46 | 47 | In order to customise _Shelf_ for your own browser, you will need to fork this repo so you can add your own content and change the layout. You can refer to [GitHub's forking documentation](https://docs.github.com/en/get-started/quickstart/fork-a-repo) if you need. 48 | 49 | Once you have _Shelf_ downloaded locally on your machine, you will need to set it as your homepage for new windows in your browser. In order to accomplish this, you will need to head to your browser settings and set the startpage for new windows and tabs to be the location of the 'index.html' file in the _Shelf_ folder (e.g., if you are on Windows this may be 'file:///C:/Users/[your-name]/projects/shelf/index.html'). Below is a list of how to accomplish this on some of the most popular browsers. 50 | 51 | - [Setting your homepage in Chrome](https://www.hellotech.com/guide/for/how-to-change-homepage-on-chrome) 52 | - [Setting your homepage in Firefox](https://support.mozilla.org/en-US/kb/how-to-set-the-home-page) 53 | - [Setting your homepage in Safari](https://support.apple.com/en-gb/guide/safari/ibrw1020/mac) 54 | - [Setting your homepage in Opera](https://browserhow.com/how-to-change-homepage-url-on-opera-browser/) 55 | - [Setting your homepage in Brave](https://browserpulse.com/how-to-change-brave-browser-default-homepage/) 56 | 57 |
58 |
59 |
60 | 61 | # Documentation 62 | 63 | The following sections detail how you can customise every part of _Shelf_ to create your very own browser startpage. However, if you are familiar with HTML, CSS, and JavaScript, you should of course experiment with more complicated customisations. 64 | 65 |
66 |
67 | 68 | ## Colour 69 | 70 | By default, _Shelf_ uses its colour scheme of purples and reds. 71 | 72 | If you want to use your own colours within _Shelf_, you simply need to change the values of the following variables (found at the top of the 'main.css' file). You can use [this](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Colors/Color_picker_tool) colour picker tool to find the colour codes, and [this](https://cssgradient.io/) tool to create your own gradients. 73 | 74 | ```css 75 | :root { 76 | --color-text: white; 77 | --color-primary: #a81759; /* Used for highlights */ 78 | --color-secondary: #171633; /* Used for backdrops of elements */ 79 | --color-tertiary: #111025; /* Used for the backdrop of the entire page */ 80 | --gradient-primary: linear-gradient( 81 | 45deg, 82 | var(--color-primary) 0%, 83 | #a81796 35%, 84 | #6c17a8 65%, 85 | #3917a8 100% 86 | ); /* Used for highlights */ 87 | --gradient-secondary: linear-gradient( 88 | 45deg, 89 | var(--color-secondary) 0%, 90 | #251633 35%, 91 | #2c1633 65%, 92 | #421531 100% 93 | ); /* Used for backdrops of elements */ 94 | } 95 | ``` 96 | 97 | You can also change the color of icons, by using [this](https://codepen.io/sosuke/pen/Pjoqqp) tool to convert a colour from HEX to a CSS filter property, which you can copy and replace in the following CSS class (found in the 'main.css' file). 98 | 99 | ```css 100 | .grid-element svg { 101 | filter: invert(100%) sepia(0%) saturate(2%) hue-rotate(128deg) brightness( 102 | 103% 103 | ) contrast(101%); 104 | } 105 | ``` 106 | 107 |
108 |
109 | 110 | ## Clock 111 | 112 | By default, _Shelf_ has a clock at the top of the page. 113 | 114 | If you want to remove the clock, you can delete the following HTML (found towards the top of the 'index.html' file). 115 | 116 | ```html 117 |
118 |
12:00
119 |
120 | ``` 121 | 122 | You will also need to remove the following JavaScript (found at the bottom of the 'main.js' file). 123 | 124 | ```javascript 125 | const timeElement = document.querySelector("#time"); 126 | function updateTime() { 127 | const date = new Date(); 128 | var hour = date.getHours().toString(); 129 | if (hour.length === 1) hour = "0" + hour; 130 | var minute = date.getMinutes().toString(); 131 | if (minute.length === 1) minute = "0" + minute; 132 | const seconds = date.getSeconds(); 133 | 134 | timeElement.textContent = hour + ":" + minute; 135 | setTimeout(updateTime, 1 - seconds); 136 | } 137 | updateTime(); 138 | ``` 139 | 140 |
141 |
142 | 143 | ## Searchbar 144 | 145 | By default, _Shelf_ has a searchbar at the top of the page, that searches with Google. 146 | 147 |
148 | 149 | ### Change Search Engine 150 | 151 | If you want to change the search engine used, then you will need to change the value of the following JavaScript variable (found at the top of the 'main.js' file), to the query link of your desired search engine. For example, if you wanted to use DuckDuckGo, it would be 'https://duckduckgo.com/?q='. 152 | 153 | ```javascript 154 | const searchEngine = "https://google.com/search?q="; 155 | ``` 156 | 157 | If you change the search engine, then you will also want to change the placeholder text in the search bar to reflect your choice. You can do this by replacing the 'placeholder' property in the following HTML (found towards the top of the 'index.html' file). 158 | 159 | ```html 160 | 161 | ``` 162 | 163 |
164 | 165 | ### Change Layout 166 | 167 | If you want the searchbar to fit with the rest of the grid, then you will need to delete the following CSS properties (found in the 'main.css' file). You may also want to refer to the [Layout](#layout) section, for more information on how elements of arranged in _Shelf_. 168 | 169 | ```css 170 | #search { 171 | width: 65em; 172 | margin: 0 auto calc(2.85rem + var(--gap)) auto; 173 | } 174 | ``` 175 | 176 |
177 | 178 | ### Delete 179 | 180 | If you want to remove the searchbar, you can delete the following HTML (found towards the top of the 'index.html' file). 181 | 182 | ```html 183 |
184 | 187 |
188 | ``` 189 | 190 | You will also need to remove the following JavaScript (found at the top of the 'main.js' file). 191 | 192 | ```javascript 193 | const searchForm = document.querySelector("#search"); 194 | const searchBar = searchForm[0]; 195 | const searchEngine = "https://google.com/search?q="; 196 | searchBar.focus(); 197 | searchForm.onsubmit = (e) => { 198 | e.preventDefault(); 199 | const query = searchBar.value.replace(/ /g, "+"); 200 | if (validURL(query)) return (window.location.href = query); 201 | else return (window.location.href = "" + searchEngine + query); 202 | }; 203 | function validURL(str) { 204 | var pattern = new RegExp( 205 | "^(https?:\\/\\/)?" + 206 | "((([a-z\\d]([a-z\\d-]*[a-z\\d])*)\\.)+[a-z]{2,}|" + 207 | "((\\d{1,3}\\.){3}\\d{1,3}))" + 208 | "(\\:\\d+)?(\\/[-a-z\\d%_.~+]*)*" + 209 | "(\\?[;&a-z\\d%_.~+=-]*)?" + 210 | "(\\#[-a-z\\d_]*)?$", 211 | "i" 212 | ); 213 | return !!pattern.test(str); 214 | } 215 | ``` 216 | 217 |
218 |
219 | 220 | ## Layout 221 | 222 | Elements in _Shelf_ are arranged using CSS Grid. 223 | 224 |
225 | 226 | ### Change Height of Links 227 | 228 | In order to change the smallest height that link elements can be, change the 'min-height' property in the following CSS class (found in 'main.css'). 229 | 230 | ```css 231 | .grid-element { 232 | min-height: 6rem; 233 | } 234 | ``` 235 | 236 |
237 | 238 | ### Change Links to be the Same Height 239 | 240 | In order to make all of the links have the same height (as opposed to filling the available space), change the 'grid-template-rows' property in the following CSS class (found in the 'main.css' file). Set the value to 'repeat(x, 1fr)', where x is the largest number of links you have (vertically) in any column. 241 | 242 | ```css 243 | .grid-rows { 244 | display: grid; 245 | grid-template-rows: repeat(4, 1fr); 246 | } 247 | ``` 248 | 249 |
250 |
251 | 252 | ## Content 253 | 254 | By default, _Shelf_ comes with a few demo bookmarks (such as YouTube, Spotify, and Gmail). However, you will of course want to change these in order to document your own links. 255 | 256 |
257 | 258 | ### Links 259 | 260 | A link consists of the following HTML (found in the 'index.html' file). 261 | 262 | ```html 263 | 264 | 265 | [INSERT-LINK-ICON-SVG-PATH] 266 | 267 |

[INSERT-LINK-NAME]

268 | 269 | ``` 270 | 271 | In order to create a new link, place one of these HTML elements in any of the 'grid-rows' HTML containers (found in the 'index.html' file), such as the following. 272 | 273 | ```html 274 |
275 |
276 | 277 | 278 | ... 279 | 280 |

YouTube

281 | 282 | 283 | 284 | [INSERT-LINK-ICON-SVG-PATH] 285 | 286 |

[INSERT-LINK-NAME]

287 | 288 |
289 |
290 | ``` 291 | 292 | Then fill in the URL and name fields. In order to find an icon for the link, you can use a range of websites that provide SVG icons. For the demo, I sourced all of the icons from [Boxicons](https://boxicons.com/). In order to do this, select the icon you want in Boxicons, and press the 'SVG CODE' button in the pop-up menu. The SVG will be copied to your clipboard. 293 | 294 | When you copy an SVG from Boxicons, it looks like the following. 295 | 296 | ```html 297 | 303 | 306 | 307 | ``` 308 | 309 | Delete the 'style' attribute, and place it in your link element so that it looks like the following. 310 | 311 | ```html 312 | 313 | 314 | 317 | 318 |

YouTube

319 | 320 | ``` 321 | 322 | You can repeat this process as many times as you want, in order to create as many links as you need! 323 | 324 |
325 | 326 | ### Headings 327 | 328 | If you want to add headings to each of the columns, you can add the following HTML nested as the first element under a 'grid-rows' container (found in the 'index.html' file). 329 | 330 | ```html 331 |
332 |

[INSERT-HEADING-NAME]

333 |
334 | ``` 335 | 336 | For example, a column could look like the following. 337 | 338 | ```html 339 |
340 |
341 |

Entertainment

342 |
343 | ... 344 | ... 345 | ... 346 |
347 | ``` 348 | 349 | If you make this change, you will also need to update the 'grid-rows' CSS class (found in the 'main.css' file) in order to structure the rows in each column correctly. All you have to do for this to work is add '6.5rem' (or, whatever height you have set your link elements to be - if you changed them) before the value already set for 'grid-template-rows'. 350 | 351 | This means, if you have your link elements set to auto size (this is the default setting), your updated property value should look like the following. 352 | 353 | ```css 354 | .grid-rows { 355 | grid-template-rows: 6.5rem auto; 356 | } 357 | ``` 358 | 359 | Or, if you changed your link elements to be the same height (in the [layout](#layout) section), your updated property value should look like the following (just apply the same rules to the 'repeat' function as detailed in the [layout](#layout) section, when setting the link elements to be the same size). 360 | 361 | ```css 362 | .grid-rows { 363 | grid-template-rows: 6.5rem repeat(4, 1fr); 364 | } 365 | ``` 366 | 367 |
368 |
369 |
370 | 371 | # Contributing 372 | 373 | If you think _Shelf_ is lacking in any way (whether that be the project itself, or the documentation), feel free to open a pull request with your changes or new features. 374 | 375 |
376 |
377 |
378 | 379 | # Forking Guidelines & License Notice 380 | 381 | I encourage everyone to fork this project and modify it to their needs, or to take pieces and incorporate those into their own projects (no credit is required). 382 | -------------------------------------------------------------------------------- /favicon.svg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | -------------------------------------------------------------------------------- /index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | Shelf 10 | 11 | 12 |
13 |
14 |
12:00
15 |
16 |
17 | 21 |
22 |
23 |
24 | 27 | 28 | 29 | 31 | 32 | 33 |

YouTube

34 | 35 | 36 | 37 | 39 | 40 | 41 |

Twitch

42 | 43 | 44 | 45 | 47 | 48 | 49 |

Spotify

50 | 51 |
52 |
53 | 56 | 57 | 60 | 61 | 63 | 64 | 65 | 66 |

Bevl

67 | 68 |
69 |
70 | 73 | 74 | 75 | 77 | 78 | 79 |

Gmail

80 | 81 | 82 | 83 | 84 | 86 | 87 | 89 | 90 | 91 |

Reddit

92 | 93 |
94 |
95 | 98 | 99 | 100 | 102 | 103 | 104 |

GitHub

105 | 106 | 107 | 108 | 110 | 111 | 112 |

CodePen

113 | 114 | 115 | 116 | 118 | 119 | 120 |

Netlify

121 | 122 | 123 | 124 | 126 | 127 | 128 |

MongoDB

129 | 130 |
131 |
132 |
133 | 134 | 135 | -------------------------------------------------------------------------------- /main.css: -------------------------------------------------------------------------------- 1 | * { 2 | margin: 0; 3 | padding: 0; 4 | font-family: sans-serif; 5 | } 6 | 7 | :root { 8 | --color-text: white; 9 | --color-primary: #a81759; /* Used for highlights */ 10 | --color-secondary: #171633; /* Used for backdrops of elements */ 11 | --color-tertiary: #111025; /* Used for the backdrop of the entire page */ 12 | --gradient-primary: linear-gradient( 13 | 45deg, 14 | var(--color-primary) 0%, 15 | #a81796 35%, 16 | #6c17a8 65%, 17 | #3917a8 100% 18 | ); /* Used for highlights */ 19 | --gradient-secondary: linear-gradient( 20 | 45deg, 21 | var(--color-secondary) 0%, 22 | #251633 35%, 23 | #2c1633 65%, 24 | #421531 100% 25 | ); /* Used for backdrops of elements */ 26 | 27 | --gap: 1rem; 28 | 29 | --border-radius: 0.35rem; 30 | --border-size: 0.25rem; 31 | 32 | --transition-duration: 250ms; 33 | } 34 | 35 | html { 36 | width: 100%; 37 | min-height: 100%; 38 | } 39 | 40 | body { 41 | width: 100%; 42 | min-height: 100vh; 43 | height: 100%; 44 | background-color: var(--color-tertiary); 45 | } 46 | 47 | main { 48 | min-height: 100vh; 49 | padding: var(--gap); 50 | box-sizing: border-box; 51 | } 52 | 53 | section:not(:last-child) { 54 | margin-bottom: var(--gap); 55 | } 56 | 57 | h2 { 58 | width: fit-content; 59 | height: fit-content; 60 | color: var(--color-text); 61 | } 62 | 63 | h3 { 64 | font-size: 1.15rem; 65 | color: var(--color-text); 66 | } 67 | 68 | .grid-columns { 69 | height: 100% !important; 70 | display: grid; 71 | grid-template-columns: repeat(4, 1fr); 72 | gap: var(--gap); 73 | } 74 | 75 | @media (max-width: 1250px) { 76 | .grid-columns { 77 | grid-template-columns: repeat(2, 1fr); 78 | } 79 | } 80 | 81 | @media (max-width: 850px) { 82 | .grid-columns { 83 | grid-template-columns: repeat(1, 1fr); 84 | } 85 | } 86 | 87 | .grid-rows { 88 | display: grid; 89 | grid-template-rows: auto; 90 | gap: var(--gap); 91 | } 92 | 93 | .grid-heading { 94 | padding-top: 3.65em; 95 | } 96 | 97 | .grid-element { 98 | min-height: 6rem; 99 | padding: var(--gap); 100 | box-sizing: border-box; 101 | color: var(--color-text); 102 | text-decoration: none; 103 | background-color: var(--color-secondary); 104 | background-image: var(--gradient-secondary); 105 | background-size: 150% 100%; 106 | border-radius: var(--border-radius); 107 | display: flex; 108 | align-items: center; 109 | position: relative; 110 | transition-property: background-position; 111 | transition-duration: var(--transition-duration); 112 | transition-timing-function: ease-out; 113 | } 114 | 115 | .grid-element:hover { 116 | background-position: 100% 0; 117 | } 118 | 119 | .grid-element::after, 120 | #search::after { 121 | content: ""; 122 | position: absolute; 123 | inset: auto 0 0 0; 124 | width: 100%; 125 | height: 0.4em; 126 | background-color: var(--color-primary); 127 | background-image: var(--gradient-primary); 128 | background-size: 150% 100%; 129 | border-radius: 0 0 var(--border-radius) var(--border-radius); 130 | transition-property: background-position; 131 | transition-duration: var(--transition-duration); 132 | transition-timing-function: ease-out; 133 | } 134 | 135 | .grid-element:hover::after, 136 | #search:hover::after { 137 | background-position: 100% 0; 138 | } 139 | 140 | .grid-element:focus, 141 | #search input:focus { 142 | outline-color: var(--color-primary); 143 | outline-width: var(--border-size); 144 | outline-style: solid; 145 | } 146 | 147 | .grid-element svg { 148 | margin-right: var(--gap); 149 | transform: scale(1.35); 150 | } 151 | 152 | .grid-element svg { 153 | filter: invert(100%) sepia(0%) saturate(2%) hue-rotate(128deg) 154 | brightness(103%) contrast(101%); 155 | } 156 | 157 | #time { 158 | width: fit-content; 159 | margin: 2.85rem auto 0 auto; 160 | font-size: 3.5rem; 161 | color: transparent; 162 | background-image: var(--gradient-primary); 163 | background-clip: text; 164 | -webkit-background-clip: text; 165 | user-select: none; 166 | } 167 | 168 | #search { 169 | max-width: 65em; 170 | margin: 0 auto calc(2.85rem + var(--gap)) auto; 171 | position: relative; 172 | } 173 | 174 | @media (max-width: 67em) { 175 | #search { 176 | margin: 0; 177 | } 178 | } 179 | 180 | #search input { 181 | width: 100%; 182 | font-size: 1rem; 183 | border: none; 184 | color: var(--color-text); 185 | } 186 | -------------------------------------------------------------------------------- /main.js: -------------------------------------------------------------------------------- 1 | const searchForm = document.querySelector("#search"); 2 | const searchBar = searchForm[0]; 3 | const searchEngine = "https://google.com/search?q="; 4 | searchBar.focus(); 5 | searchForm.onsubmit = (e) => { 6 | e.preventDefault(); 7 | const query = searchBar.value.replace(/ /g, "+"); 8 | if (validURL(query)) { 9 | if (!query.startsWith("https://")) 10 | return (window.location.href = "https://" + query); 11 | else window.location.href = query; 12 | } else return (window.location.href = "" + searchEngine + query); 13 | }; 14 | function validURL(str) { 15 | var pattern = new RegExp( 16 | "^(https?:\\/\\/)?" + 17 | "((([a-z\\d]([a-z\\d-]*[a-z\\d])*)\\.)+[a-z]{2,}|" + 18 | "((\\d{1,3}\\.){3}\\d{1,3}))" + 19 | "(\\:\\d+)?(\\/[-a-z\\d%_.~+]*)*" + 20 | "(\\?[;&a-z\\d%_.~+=-]*)?" + 21 | "(\\#[-a-z\\d_]*)?$", 22 | "i" 23 | ); 24 | return !!pattern.test(str); 25 | } 26 | 27 | const timeElement = document.querySelector("#time"); 28 | function updateTime() { 29 | const date = new Date(); 30 | var hour = date.getHours().toString(); 31 | if (hour.length === 1) hour = "0" + hour; 32 | var minute = date.getMinutes().toString(); 33 | if (minute.length === 1) minute = "0" + minute; 34 | const seconds = date.getSeconds(); 35 | 36 | timeElement.textContent = hour + ":" + minute; 37 | setTimeout(updateTime, 1 - seconds); 38 | } 39 | updateTime(); 40 | --------------------------------------------------------------------------------