https://github.com/ttntm/startpage
A minimal, fully customizable start page for your browser.
https://github.com/ttntm/startpage
bookmarks customization homepage homepage-tabs minimal startpage template-repository
Last synced: 3 months ago
JSON representation
A minimal, fully customizable start page for your browser.
- Host: GitHub
- URL: https://github.com/ttntm/startpage
- Owner: ttntm
- License: gpl-3.0
- Created: 2021-04-06T07:08:12.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2023-01-25T10:42:51.000Z (over 2 years ago)
- Last Synced: 2025-03-24T20:13:15.128Z (3 months ago)
- Topics: bookmarks, customization, homepage, homepage-tabs, minimal, startpage, template-repository
- Language: Nunjucks
- Homepage: https://startpage-demo.netlify.app/
- Size: 168 KB
- Stars: 9
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
startpage
A customizable start page for your browser.
Built using Eleventy.
## Usage Instructions
1. Clone this repository to your local machine
2. `cd` into the cloned folder
3. Run `npm install`
4. `npm run serve` to get a local development server @ `localhost:8080`
When you're satisfied, use `npm run build` to build your start page into `./public/index.html`. This file can then be set as start page and/or custom "New Tab" page in your browser (see: [New Tab Changer (Chromium)](https://chrome.google.com/webstore/detail/new-tab-changer/occbjkhimchkolibngmcefpjlbknggfh/) or [New Tab Override (Firefox)](https://addons.mozilla.org/en-US/firefox/addon/new-tab-override/) for example).
### Customize Categories
Categories (cards; grid items) are defined in `./src/_data/categories.json`; their `name` property is used to categorize your links = display them in the corresponding section.
Note: **The order your categories are defined in also sets the order in which they are displayed.**
### Add Your Links
Links can be edited in `./src/_data/links.json`. They are defined as follows:
```json
{
"category": "CategoryName",
"name": "LinkName",
"url": "LinkURL"
}
```
The `category` key should correspond to one of the categories defined in your `categories.json` - links with wrong or missing `category` values will be ignored.
The order you define links in *does not matter*; links will also be sorted alphabetically by default.
If this A-Z sorting is not desired, simply change your `./src/index.njk` file from this:
```
{% for item in links | sort(attribute = 'name') %}
```
To this:
```
{% for item in links %}
```
Links will then follow the order they've been added in, based on your `links.json` file.
### Customize Styling
All CSS can be found in `./src/_includes/css.njk` and will be inlined into the generated `index.html`.
## Feedback
Please use [GitHub discussions](https://github.com/ttntm/startpage/discussions) for that, thanks!