Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CSS refactoring #252

Merged
merged 11 commits into from
Sep 15, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions .remarkrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
{
"plugins": [
["remark-lint-no-dead-urls", { "skipLocalhost": true }],
"remark-validate-links",
"remark-lint-heading-capitalization",
"remark-lint-code-block-split-list",
"remark-lint-fenced-code-flag",
"remark-lint-first-heading-level",
"remark-lint-heading-increment",
"remark-lint-no-shell-dollars",
["remark-lint-match-punctuation", ["“”", "()"]],
"remark-lint-check-toc",
"remark-lint-smarty-pants-typography"
]
}
17 changes: 0 additions & 17 deletions .remarkrc.js

This file was deleted.

4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ Slow Reader is a local-first app. Clients do most of the work, and the server ju
- [`docs/`](./docs/): guides for developers.
- [`scripts/`](./scripts/): scripts to test project and configure Google Cloud. Check the script’s descriptions for further details.
- [`loader-tests/`](./loader-tests/): integration tests for each social network or news format.
- [`.devcontainer`](./.devcontainer/): `Dockerfile` and configs to run project in Docker/Podman image on developer’s machine. It increases security (malicious dependency will not have access to the whole machine) and simplify onboarding.
- [`.devcontainer`](./.devcontainer/): `Dockerfile` and configs to run project in Docker/Podman image on developer’s machine. It increases security (malicious dependency will not have access to the whole machine) and simplify onboarding. We have configs for Docker and [Podman](https://podman.io) (more secure version of Docker).
- [`.github/`](./.github/): scripts to test projects on CI.
- [`.husky/`](./.husky/): scripts to call on `git commit` command to avoid popular errors.
- [`.vscode/`](./.vscode/): VS Code settings to reduce code format errors for new contributors.
Expand All @@ -122,7 +122,7 @@ Global development tools:
- [Prettier](./.prettierrc) to use the same code style formatting.
- [TypeScript](./tsconfig.json) for strict type checking.
- [ESLint](./eslint.config.js) to check for popular mistakes in JavaScript.
- [remark](./.remarkrc.js) to find mistakes in `.md` files.
- [remark](./.remarkrc) to find mistakes in `.md` files.

Each project has its own tools, too.

Expand Down
7 changes: 4 additions & 3 deletions docs/new_page.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ If we are adding `foo` page.
2. Export these files from `core/messages/index.ts`.
4. Add page:
1. Create Svelte component `web/pages/foo.svelte` using `foo` messages and `foo` core module.
2. Use this component with the route in `web/main/main.svelte`.
3. Add visual tests in `web/stories/pages/foo.stories.svelte`.
4. Add a link to the page to the menu (`web/ui/navbar/`) if necessary.
2. Wrap Svelte styles into `:global {}`. Use BEM system like `.foo_element.is-modifier` for CSS selectors.
3. Use this component with the route in `web/main/main.svelte`.
4. Add visual tests in `web/stories/pages/foo.stories.svelte`.
5. Add a link to the page to the menu (`web/ui/navbar/`) if necessary.
Loading