Skip to content

Commit 9a66e85

Browse files
committed
Update README with site link and description.
1 parent 9ed4a2b commit 9a66e85

File tree

2 files changed

+35
-1
lines changed

2 files changed

+35
-1
lines changed

README.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,26 @@
33
## Table Of Contents
44
- [Leetcode Solutions](#leetcode-solutions)
55
- [Table Of Contents](#table-of-contents)
6+
- [Description](#description)
7+
- [Steps](#steps)
68
- [My Leetcode Stats](#my-leetcode-stats)
79
- [Table of my Solutions](#table-of-my-solutions)
8-
10+
11+
<br/>
12+
13+
[![Open App](https://img.shields.io/badge/Site%20Link-Click%20Here-blue?style=for-the-badge&logo=vercel)](https://leetcode.romitsagu.com/)
14+
15+
## Description
16+
17+
This is a repo to store my leetcode solutions but I went a bit Schizo with it and it pulls the leetcode solutions, creates READMEs with the problema and solution and then converts it into an Mkdocs website hosted on GitHub Pages.
18+
19+
### Steps
20+
1. Uses the joshcai/leetcode-sync GitHub action to will the problems and solutions from leetcode into the /Solutions folder.
21+
2. Uses the Script ```update_project_readme.py``` to compile all of the completed projects into a table in 2 readme files that can be used for GitHub and the Mkdocs site
22+
3. Uses the Script ```update_readmes.py.py``` to create README files from the problems and solutions and embed their difficulty, tags and the solution's statistics.
23+
4. Uses Mkdocs to convert the READMEs created in `Step 3` to a website.
24+
5. The website is then deployed using the GitHub Pages deploy action.
25+
926
## My Leetcode Stats
1027

1128
<div align="center">

Site_README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,26 @@
33
## Table Of Contents
44
- [Leetcode Solutions](#leetcode-solutions)
55
- [Table Of Contents](#table-of-contents)
6+
- [Description](#description)
7+
- [Steps](#steps)
68
- [My Leetcode Stats](#my-leetcode-stats)
79
- [Table of my Solutions](#table-of-my-solutions)
810

11+
<br/>
12+
13+
[![Open App](https://img.shields.io/badge/Site%20Link-Click%20Here-blue?style=for-the-badge&logo=vercel)](https://leetcode.romitsagu.com/)
14+
15+
## Description
16+
17+
This is a repo to store my leetcode solutions but I went a bit Schizo with it and it pulls the leetcode solutions, creates READMEs with the problema and solution and then converts it into an Mkdocs website hosted on GitHub Pages.
18+
19+
### Steps
20+
1. Uses the joshcai/leetcode-sync GitHub action to will the problems and solutions from leetcode into the /Solutions folder.
21+
2. Uses the Script ```update_project_readme.py``` to compile all of the completed projects into a table in 2 readme files that can be used for GitHub and the Mkdocs site
22+
3. Uses the Script ```update_readmes.py.py``` to create README files from the problems and solutions and embed their difficulty, tags and the solution's statistics.
23+
4. Uses Mkdocs to convert the READMEs created in `Step 3` to a website.
24+
5. The website is then deployed using the GitHub Pages deploy action.
25+
926
## My Leetcode Stats
1027

1128
<div align="center">

0 commit comments

Comments
 (0)