Simple bookmark manager built with Go
Find a file
2023-08-26 10:09:00 +02:00
.githooks Add GitHub Action for tests & coverage 2020-08-06 21:08:43 +02:00
.github add publish step to actions 2023-08-26 10:09:00 +02:00
docs mkdocs wip 2023-08-26 09:47:44 +02:00
internal Swagger improvements (#666) 2023-08-12 08:38:52 +02:00
scripts add publish step to actions 2023-08-26 10:09:00 +02:00
.dockerignore Setup new CI/CD workflows (#365) 2022-02-13 16:38:54 +01:00
.gitignore mkdocs wip 2023-08-26 09:47:44 +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
app.json Revert "Restructure build files" 2019-09-26 16:25:19 +07: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 feat: add SHIORI_PG_SSLMODE (#536) 2023-07-09 08:43:26 +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 Start working on new REST API. Refactor logic in domains. (#497) 2023-07-17 14:30:18 +01:00
go.sum Start working on new REST API. Refactor logic in domains. (#497) 2023-07-17 14:30:18 +01:00
LICENSE Update LICENSE 2019-01-06 17:00:20 +07:00
main.go Show version in login page (#652) 2023-07-21 09:25:19 +02:00
Makefile add publish step to actions 2023-08-26 10:09:00 +02:00
mkdocs.yml mkdocs wip 2023-08-26 09:47:44 +02:00
Procfile Added Heroku deploy. Fixed go-shiori/shiori#45 2019-09-25 13:45:08 +03:00
README.md mkdocs wip 2023-08-26 09:47:44 +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. You can use it as a command line application or as a web application, distributed as a single binary, which means it can be installed and used easily.

You can use it as a bookmark manager or as an alternative to Pocket or other read-later services due to it's archival and readability features.

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 and by default shiori will parse the readable content.
  • Optionally create an offline archive of the webpage using warc. (See #353)
  • Optionally create an ebook from the readable content in ePub using [go-epub][go-epub].
  • [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.