Skip to content

Commit

Permalink
feat: ✨ Add lychee workflow & new components library (#47)
Browse files Browse the repository at this point in the history
* feat: add ``lychee`` command to check links

* feat: initial custom ``lychee`` config

* feat: initial check-links action with lychee

* feat: add new components library

* fix: update ``exclude`` links

* feat: update components menu with new date
  • Loading branch information
pheralb authored Jan 30, 2024
1 parent 4d89faa commit cc55027
Show file tree
Hide file tree
Showing 5 changed files with 73 additions and 2 deletions.
16 changes: 16 additions & 0 deletions .github/workflows/check-links.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
name: Links

on: [push]

jobs:
linkChecker:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3

- name: Link Checker
id: lychee
uses: lycheeverse/[email protected]
with:
fail: true
args: --config './lychee.toml' .
14 changes: 14 additions & 0 deletions docs/frontend/components_library.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ contributors:
- github_username: 'nsdonato'
- github_username: 'gonzalochale'
- github_username: 'rodrigaocabrera'
- github_username: 'pheralb'

submenu:
- imgPlaceholder: 'Shadcn'
Expand Down Expand Up @@ -215,4 +216,17 @@ submenu:
createdAt: '2024-01-28T00:00:00Z'
updatedAt: '2024-01-28T00:00:00Z'
videos: []

- imgPlaceholder: 'Buttons ibelick'
titleCard: 'Buttons ibelick'
links:
- type: 'Web'
url: 'https://buttons.ibelick.com/'
cover:
src: ''
height: 80
width: 190
createdAt: '2024-01-30T00:00:00Z'
updatedAt: '2024-01-30T00:00:00Z'
videos: []
---
2 changes: 1 addition & 1 deletion docs/menu.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ menu:
- name: 'Componentes'
url: '/docs/frontend/components_library'
createdAt: '2024-01-14T00:00:00Z'
updatedAt: '2024-01-27T00:00:00Z'
updatedAt: '2024-01-30T00:00:00Z'

- name: 'Dominios'
url: '/docs/frontend/domains'
Expand Down
40 changes: 40 additions & 0 deletions lychee.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
############################# Display #############################

# Verbose program output
# Accepts log level: "error", "warn", "info", "debug", "trace"
verbose = "info"

############################# Exclusions ##########################

# Skip missing input files (default is to error if they don't exist).
skip_missing = false

# Check links inside `<code>` and `<pre>` blocks as well as Markdown code
# blocks.
include_verbatim = false

# Ignore case of paths when matching glob patterns.
glob_ignore_case = false

# Exclude URLs and mail addresses from checking (supports regex).
exclude = ['^https://www\.twitter\.com', '^https://twitter\.com', '^https://discord\.io', '^https://discord\.com', 'https://github.com/nsdonato/recursostech/']

# Exclude these filesystem paths from getting checked.
exclude_path = ["./.git", "./.github", "./app", "./public", "./docs/doc_template_general.mdx"]

# Exclude all private IPs from checking.
# Equivalent to setting `exclude_private`, `exclude_link_local`, and
# `exclude_loopback` to true.
exclude_all_private = false

# Exclude private IP address ranges from checking.
exclude_private = false

# Exclude link-local IP address range from checking.
exclude_link_local = false

# Exclude loopback IP address range and localhost from checking.
exclude_loopback = false

# Check mail addresses
include_mail = false
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@
"test:watch": "jest --watch",
"format": "prettier -w -u .",
"prepare": "husky install",
"tsc": "tsc"
"tsc": "tsc",
"check-links": "lychee --config './lychee.toml' ."
},
"dependencies": {
"@radix-ui/react-icons": "^1.3.0",
Expand Down

0 comments on commit cc55027

Please sign in to comment.