Skip to content

Commit 9af9f1a

Browse files
committed
Siva | Update mkdocs with titles, descriptions and keywords
1 parent c5ff3a8 commit 9af9f1a

File tree

7 files changed

+155
-78
lines changed

7 files changed

+155
-78
lines changed

docs/CHANGELOG.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,20 @@
1+
---
2+
title: Changelog & Version History
3+
4+
description: "Track all updates, new features, and bug fixes in Social Links – Python library for detecting, validating, and sanitizing social media links."
5+
6+
keywords:
7+
- social-links
8+
- changelog
9+
- version history
10+
- release notes
11+
- Python library
12+
- social media links
13+
- validate
14+
- sanitize
15+
- update
16+
- bug fixes
17+
---
18+
119
--8<-- "CHANGELOG.md"
220

docs/CONTRIBUTING.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,19 @@
1+
---
2+
title: Contributing Guide
3+
4+
description: "Guide to contributing to Social Links – Python library for detecting, validating, and sanitizing social media links. Includes setup, testing, and pull request process."
5+
6+
keywords:
7+
- contributing
8+
- social-links
9+
- Python library
10+
- open source
11+
- pull requests
12+
- testing
13+
- setup
14+
- social media links
15+
- code of conduct
16+
---
17+
118
--8<-- "CONTRIBUTING.md"
219

docs/LICENSE.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,19 @@
1+
---
2+
title: MIT Open Source License
3+
4+
description: "MIT License for Social Links Python library – permissions and terms for using, modifying, and distributing this open source social media URL validation tool."
5+
6+
keywords:
7+
- MIT License
8+
- open source
9+
- social-links
10+
- Python library
11+
- social media links
12+
- terms
13+
- permissions
14+
- redistribution
15+
- modification
16+
---
17+
118
--8<-- "LICENSE"
219

docs/api.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,20 @@
1+
---
2+
title: API Reference
3+
4+
description: "API reference for Social Links Python library. Detect, validate, and sanitize social media links with detailed code examples and custom platform support."
5+
6+
keywords:
7+
- API reference
8+
- social-links
9+
- Python library
10+
- social media links
11+
- validate
12+
- sanitize
13+
- custom platform
14+
- code examples
15+
- URL detection
16+
---
17+
118
# API Reference
219

320
This page provides comprehensive documentation for all public APIs in the `social-links` library.

docs/index.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,23 @@
1+
---
2+
title: Python Library for Social Media URL Validation
3+
4+
description: "Detect, validate, and sanitize social media links in Python. Supports 50+ platforms with automatic URL normalization and username extraction."
5+
6+
keywords:
7+
- social-links
8+
- Python library
9+
- social media
10+
- URL validation
11+
- detection
12+
- sanitize
13+
- normalize
14+
- LinkedIn
15+
- GitHub
16+
- Twitter
17+
- Facebook
18+
- Instagram
19+
- YouTube
20+
---
21+
122
--8<-- "README.md"
223

mkdocs.yml

Lines changed: 35 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -49,11 +49,41 @@ extra:
4949
google_site_verification: your-google-site-verification-key
5050
og_image: https://raw.githubusercontent.com/ysskrishna/social-links/main/media/og.png
5151
keywords:
52-
- python
53-
- social media
54-
- url validation
55-
- profile detection
56-
- social links
52+
- social-links
53+
- Python library
54+
- social media links
55+
- validate
56+
- sanitize
57+
- normalize
58+
- detect
59+
- URL validation
60+
- URL parser
61+
- regular expression
62+
- regex
63+
- LinkedIn
64+
- GitHub
65+
- Twitter
66+
- X
67+
- Facebook
68+
- Instagram
69+
- YouTube
70+
- Behance
71+
- Dribbble
72+
- Medium
73+
- Reddit
74+
- Quora
75+
- Pinterest
76+
- TikTok
77+
- Discord
78+
- Mastodon
79+
- Bluesky
80+
- open source
81+
- API reference
82+
- contribution guide
83+
- changelog
84+
- version history
85+
- MIT license
86+
- ysskrishna
5787
social:
5888
- icon: fontawesome/brands/python
5989
link: https://pypi.org/project/social-links/

pyproject.toml

Lines changed: 30 additions & 73 deletions
Original file line numberDiff line numberDiff line change
@@ -25,84 +25,41 @@ classifiers = [
2525
"Topic :: Utilities"
2626
]
2727
keywords = [
28-
"apple_music",
29-
"bandcamp",
30-
"behance",
31-
"bluesky",
32-
"crunchbase",
33-
"detection",
34-
"dev_to",
35-
"discord",
36-
"douyin",
37-
"dribbble",
38-
"etsy",
39-
"exercism",
40-
"expression",
41-
"facebook",
42-
"flickr",
28+
"social-links",
29+
"python library",
30+
"social media links",
31+
"validate",
32+
"sanitize",
33+
"normalize",
34+
"detect",
35+
"url validation",
36+
"url parser",
37+
"regular expression",
38+
"regex",
39+
"linkedin",
4340
"github",
44-
"gitlab",
45-
"gravatar",
46-
"gumroad",
47-
"hashnode",
48-
"hackernews",
41+
"twitter",
42+
"x",
43+
"facebook",
4944
"instagram",
50-
"is-valid",
51-
"keybase",
52-
"kuaishou",
53-
"lemmy_world",
54-
"linkedin",
55-
"links",
56-
"linktree",
57-
"manipulation",
58-
"mastodon",
59-
"media",
45+
"youtube",
46+
"behance",
47+
"dribbble",
6048
"medium",
61-
"normalize",
62-
"patreon",
63-
"pinterest",
64-
"platform",
65-
"producthunt",
66-
"profile",
67-
"quora",
6849
"reddit",
69-
"regex",
70-
"regexp",
71-
"regular",
72-
"regular expression",
73-
"sanitization",
74-
"sanitize",
75-
"signal",
76-
"slideshare",
77-
"snapchat",
78-
"social",
79-
"social-links",
80-
"social-media",
81-
"soundcloud",
82-
"spotify",
83-
"stackoverflow",
84-
"steam",
85-
"string",
86-
"substack",
87-
"telegram",
88-
"threads",
50+
"quora",
51+
"pinterest",
8952
"tiktok",
90-
"trim",
91-
"tumblr",
92-
"twitch",
93-
"twitter",
94-
"url",
95-
"url-parser",
96-
"validate",
97-
"validation",
98-
"vimeo",
99-
"vk",
100-
"wechat",
101-
"weibo",
102-
"wellfound",
103-
"whatsapp",
104-
"x",
105-
"youtube"
53+
"discord",
54+
"mastodon",
55+
"bluesky",
56+
"open source",
57+
"api reference",
58+
"contribution guide",
59+
"changelog",
60+
"version history",
61+
"mit license",
62+
"ysskrishna"
10663
]
10764
dependencies = []
10865

0 commit comments

Comments
 (0)