Simple bookmark manager built with Go
Find a file
cbe 7765e5bf42
chore: frontend formatting (#764)
* Install `prettier`

Ignore everything in the first step as I want to see the size of changes
that are going to happen first

* Configure prettier

- use tabs as the whole project prefers tabs
- ignore a bunch of files that shouldn't be formatted

* Check & format with prettier when compiling less

* Update docs to use bun

Since bun handles the dependencies used for the CSS compilation this
should be the preferred method from now on.

* Check actual result of prettier

* Use LF line endings

All files where formatted in LF and since it's most common in git repos
we should probably keep it this way

* Limit prettier to `internal/view/`

See pull request review
https://github.com/go-shiori/shiori/pull/764#pullrequestreview-1702935417

* Format code with prettier
2023-11-05 11:02:31 +01:00
.githooks Add GitHub Action for tests & coverage 2020-08-06 21:08:43 +02:00
.github chore(deps): bump the all group with 1 update (#767) 2023-10-29 11:01:47 +01:00
docs chore: frontend formatting (#764) 2023-11-05 11:02:31 +01:00
internal chore: frontend formatting (#764) 2023-11-05 11:02:31 +01:00
scripts chore: frontend formatting (#764) 2023-11-05 11:02:31 +01:00
testdata fix: Ensure bookmark files are correctly downloaded before deleting current ones (#683) 2023-08-20 18:20:13 +02:00
.dockerignore Setup new CI/CD workflows (#365) 2022-02-13 16:38:54 +01:00
.gitignore feat: build css from less files locally (#735) 2023-09-16 19:58:55 +02:00
.golangci.yml Start working on new REST API. Refactor logic in domains. (#497) 2023-07-17 14:30:18 +01:00
.goreleaser.yaml Start working on new REST API. Refactor logic in domains. (#497) 2023-07-17 14:30:18 +01:00
.prettierignore chore: frontend formatting (#764) 2023-11-05 11:02:31 +01:00
.prettierrc chore: frontend formatting (#764) 2023-11-05 11:02:31 +01:00
app.json
bun.lockb chore: frontend formatting (#764) 2023-11-05 11:02:31 +01:00
CODE_OF_CONDUCT.md Update links and email addresses 2020-08-06 22:26:59 +02:00
coverage.txt Start working on new REST API. Refactor logic in domains. (#497) 2023-07-17 14:30:18 +01:00
docker-compose.yaml fix: properly parse mysql connection string, docs update (#730) 2023-09-13 18:31:41 +02:00
Dockerfile Run legacy API and new API at the same time. (#648) 2023-07-19 18:25:41 +02:00
Dockerfile.compose Run legacy API and new API at the same time. (#648) 2023-07-19 18:25:41 +02:00
go.mod fix: allow webp thumbnails (#758) 2023-10-22 15:06:08 +02:00
go.sum chore(deps): bump golang dependencies (#746) 2023-10-03 07:54:08 +02:00
LICENSE
main.go Show version in login page (#652) 2023-07-21 09:25:19 +02:00
Makefile refactor: migrate ebook routes to new http server (#742) 2023-10-29 11:57:07 +01:00
package.json chore: frontend formatting (#764) 2023-11-05 11:02:31 +01:00
Procfile
README.md chore: remove irc badge from readme (#674) 2023-07-26 09:10:35 +02:00

Shiori

IC Go Report Card #shiori-general:matrix.org Containers

Check out our latest Announcements

Shiori is a simple bookmarks manager written in the Go language. Intended as a simple clone of Pocket. You can use it as a command line application or as a web application. This application is distributed as a single binary, which means it can be installed and used easily.

Screenshot

Features

  • Basic bookmarks management i.e. add, edit, delete and search.
  • Import and export bookmarks from and to Netscape Bookmark file.
  • Import bookmarks from Pocket.
  • Simple and clean command line interface.
  • Simple and pretty web interface for those who don't want to use a command line app.
  • Portable, thanks to its single binary format.
  • Support for sqlite3, PostgreSQL and MySQL as its database.
  • Where possible, by default shiori will parse the readable content and create an offline archive of the webpage.
  • [BETA] web extension support for Firefox and Chrome.

Comparison of reader mode and archive mode

Documentation

All documentation is available in the docs folder. If you think there is incomplete or incorrect information, feel free to edit it by submitting a pull request.

License

Shiori is distributed under the terms of the MIT license, which means you can use it and modify it however you want. However, if you make an enhancement for it, if possible, please send a pull request.