Skip to content

Commit

Permalink
feat(init): first commit
Browse files Browse the repository at this point in the history
  • Loading branch information
yoyurec committed Sep 27, 2022
0 parents commit efacc2e
Show file tree
Hide file tree
Showing 21 changed files with 4,230 additions and 0 deletions.
17 changes: 17 additions & 0 deletions .eslintrc.json
@@ -0,0 +1,17 @@
{
"extends": [
"eslint:recommended",
"plugin:@typescript-eslint/eslint-recommended",
"plugin:@typescript-eslint/recommended"
],
"plugins": ["@typescript-eslint"],
"parser": "@typescript-eslint/parser",
"rules": {
"import/prefer-default-export": "off",
"@typescript-eslint/ban-ts-comment": "off",
"@typescript-eslint/no-non-null-assertion": "off",
"@typescript-eslint/explicit-module-boundary-types": "off",
"@typescript-eslint/no-unused-vars": ["error", { "ignoreRestSiblings": true }],
"quotes": ["error", "single", { "allowTemplateLiterals": true }]
}
}
4 changes: 4 additions & 0 deletions .github/FUNDING.yml
@@ -0,0 +1,4 @@
# These are supported funding model platforms

custom: https://www.buymeacoffee.com/yoyurec

29 changes: 29 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,29 @@
---
name: Bug report
about: Create a report to help improve theme
title: ''
labels: ''
assignees: ''

---

**Info:**
- OS:
- Logseq ver:
- Theme ver:
- [ ] ⚠ Do i have issue with DISABLED my `custom.css`?

**Description:**
A clear and concise description of what the bug is......

**To Reproduce:**
...

**Expected behavior:**
...

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Attach files**
Add (via drag-n-drop) .zip with `.md` files (if it needs) to help with bugfixind
17 changes: 17 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,17 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: ''
assignees: ''

---

**Idea**
A clear and concise description of what you want to happen.

**Screenshots**
Add some pictures to get the idea if needed

**Attach files**
Add (via drag-n-drop) .zip with `.md` files if it help me with experiments
45 changes: 45 additions & 0 deletions .github/workflows/main.yml
@@ -0,0 +1,45 @@
name: Releases

env:
PLUGIN_NAME: logseq-sticky-headers

on:
push:
branches: [ "main" ]
pull_request:
branches: [ "main" ]
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

jobs:
release:
runs-on: ubuntu-latest
steps:
- name: Checkout Repo
uses: actions/checkout@v3

- name: Setup Node.js 16
uses: actions/setup-node@v3
with:
node-version: "16"

- name: Setup pnpm
uses: pnpm/action-setup@v2.2.2
with:
version: 7

- name: Install dependencies
run: pnpm install

- name: Build dist
run: pnpm build

- name: Install zip
uses: montudor/action-zip@v1

- name: Release
run: npx semantic-release

env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
4 changes: 4 additions & 0 deletions .gitignore
@@ -0,0 +1,4 @@
node_modules
.DS_Store
dist
*.local
19 changes: 19 additions & 0 deletions .prettierrc.json
@@ -0,0 +1,19 @@
{
"arrowParens": "always",
"bracketSameLine": false,
"bracketSpacing": true,
"embeddedLanguageFormatting": "auto",
"htmlWhitespaceSensitivity": "css",
"insertPragma": false,
"jsxSingleQuote": false,
"printWidth": 80,
"proseWrap": "preserve",
"quoteProps": "as-needed",
"requirePragma": false,
"semi": true,
"singleQuote": true,
"tabWidth": 4,
"trailingComma": "es5",
"useTabs": false,
"vueIndentScriptAndStyle": false
}
Empty file added CHANGELOG.md
Empty file.
21 changes: 21 additions & 0 deletions LICENSE
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2022 Yuriy Piskun

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
40 changes: 40 additions & 0 deletions README.md
@@ -0,0 +1,40 @@
<h1 align="center">"Sticky headers" plugin for Logseq</h1>
<p align="center">
<a href="https://github.com/yoyurec/logseq-sticky-headers">
<img src="icon.png" alt="logo" width="128" height="128" />
</a>
</p>

H1-H5 headers in page will "stick" to top on page scroll, helping you not to loose reading section name.

⚠ ! Calculations are very tricky, so reload logseq after inslallin/uninstalling Tabs plugin or enabling themes! ⚠

![Sticky headers](screenshots/sticky-headers.gif)


## If you ❤ what i'm doing - you can support my work! ☕
<a href="https://www.buymeacoffee.com/yoyurec" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" style="height: 50px !important;width: 178px !important;" ></a>

## Install theme
From Logseq store - `Plugins -> Marketplace`.

![](./screenshots/market.png)


## Recommended plugins
* 🐱‍👤 [Solarized Extended](https://github.com/yoyurec/logseq-solarized-extended-theme) theme
*[Awesome Links](https://github.com/yoyurec/logseq-awesome-links)

## What is Logseq?
Logseq is a privacy-first, open-source knowledge base. Visit https://logseq.com for more information.

## Support
* Read about Logseq plugin updates on Dicscord - https://discord.com/channels/725182569297215569/896368413243494430
* Ask about Logseq plugins on Dicscord - https://discord.com/channels/725182569297215569/752845167030960141
* If you have any questions, issues or feature request, use the issue submission on GitHub: https://github.com/yoyurec/logseq-sticky-headers/issues

## Credits
* Icon - https://www.flaticon.com/free-icon/banana_3369612

## License
[MIT License](./LICENSE)
Binary file added icon.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
13 changes: 13 additions & 0 deletions index.html
@@ -0,0 +1,13 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Sticky Headers plugin</title>
</head>
<body>
<div id="app"></div>
<script src="/src/js/stickyHeaders.ts" type="module"></script>
</body>
</html>
47 changes: 47 additions & 0 deletions package.json
@@ -0,0 +1,47 @@
{
"name": "logseq-sticky-headers",
"description": "Sticky H1-H5 headers on page scroll",
"version": "0.0.1",
"author": "yoyurec <yoyurec@gmail.com>",
"main": "dist/index.html",
"scripts": {
"dev": "vite",
"build": "tsc && vite build",
"preinstall": "npx only-allow pnpm",
"semantic-release": "semantic-release"
},
"config": {
"commitizen": {
"path": "cz-conventional-changelog"
}
},
"dependencies": {
"@logseq/libs": "0.0.8"
},
"devDependencies": {
"@semantic-release/changelog": "^6.0.1",
"@semantic-release/exec": "^6.0.3",
"@semantic-release/git": "^10.0.1",
"@semantic-release/npm": "^9.0.1",
"@typescript-eslint/eslint-plugin": "^5.38.1",
"@typescript-eslint/parser": "^5.38.1",
"conventional-changelog-conventionalcommits": "^5.0.0",
"cz-conventional-changelog": "3.3.0",
"eslint": "^8.24.0",
"semantic-release": "^19.0.5",
"typescript": "^4.8.4",
"vite": "3.1.3",
"vite-plugin-logseq": "^1.1.2"
},
"license": "MIT",
"logseq": {
"title": "Sticky Headers",
"icon": "./icon.png",
"id": "logseq-sticky-headers"
},
"repository": "https://github.com/yoyurec/logseq-sticky-headers.git",
"effect": true,
"sponsors": [
"https://www.buymeacoffee.com/yoyurec"
]
}

0 comments on commit efacc2e

Please sign in to comment.