generated from just-the-docs/just-the-docs-template
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
77 changed files
with
19,488 additions
and
197 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
--- | ||
name: Bug report | ||
about: Create a report to help us improve | ||
title: '' | ||
labels: '' | ||
assignees: '' | ||
|
||
--- | ||
|
||
**Describe the bug** | ||
A clear and concise description of what the bug is. | ||
|
||
**To Reproduce** | ||
Steps to reproduce the behavior: | ||
1. Go to '...' | ||
2. Click on '....' | ||
3. Scroll down to '....' | ||
4. See error | ||
|
||
**Expected behavior** | ||
A clear and concise description of what you expected to happen. | ||
|
||
**Screenshots** | ||
If applicable, add screenshots to help explain your problem. | ||
|
||
**Desktop (please complete the following information):** | ||
- OS: [e.g. iOS] | ||
- Browser [e.g. chrome, safari] | ||
- Version [e.g. 22] | ||
|
||
**Smartphone (please complete the following information):** | ||
- Device: [e.g. iPhone6] | ||
- OS: [e.g. iOS8.1] | ||
- Browser [e.g. stock browser, safari] | ||
- Version [e.g. 22] | ||
|
||
**Additional context** | ||
Add any other context about the problem here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
blank_issues_enabled: false | ||
contact_links: | ||
- name: Ask a question | ||
url: https://github.com/kevinlin1/just-the-class/discussions | ||
about: Ask questions and discuss with other community members |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
--- | ||
name: Feature request | ||
about: Suggest an idea for this project | ||
title: '' | ||
labels: '' | ||
assignees: '' | ||
|
||
--- | ||
|
||
**Is your feature request related to a problem? Please describe.** | ||
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] | ||
|
||
**Describe the solution you'd like** | ||
A clear and concise description of what you want to happen. | ||
|
||
**Describe alternatives you've considered** | ||
A clear and concise description of any alternative solutions or features you've considered. | ||
|
||
**Additional context** | ||
Add any other context or screenshots about the feature request here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,15 +1,5 @@ | ||
# Not sure what a .gitignore is? | ||
# See: https://git-scm.com/docs/gitignore | ||
|
||
# These are directly copied from Jekyll's first-party docs on `.gitignore` files: | ||
# https://jekyllrb.com/tutorials/using-jekyll-with-bundler/#commit-to-source-control | ||
|
||
# Ignore the default location of the built site, and caches and metadata generated by Jekyll | ||
_site/ | ||
.sass-cache/ | ||
.jekyll-cache/ | ||
_site | ||
.sass-cache | ||
.jekyll-cache | ||
.jekyll-metadata | ||
|
||
# Ignore folders generated by Bundler | ||
.bundle/ | ||
vendor/ | ||
vendor |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
sharif-llm.ir |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,2 @@ | ||
source 'https://rubygems.org' | ||
|
||
gem "jekyll", "~> 4.3.3" # installed by `gem jekyll` | ||
# gem "webrick" # required when using Ruby >= 3 and Jekyll <= 4.2.2 | ||
|
||
gem "just-the-docs", "0.8.2" # pinned to the current release | ||
# gem "just-the-docs" # always download the latest release | ||
gem 'github-pages', group: :jekyll_plugins |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,174 +1,17 @@ | ||
# just-the-docs-template | ||
--- | ||
layout: home | ||
title: DA Course | ||
nav_exclude: true | ||
permalink: /:path/ | ||
seo: | ||
type: Course | ||
name: Designing Algorithms | ||
--- | ||
|
||
This is a *bare-minimum* template to create a [Jekyll] site that: | ||
# Designing Algorithms Course | ||
|
||
- uses the [Just the Docs] theme; | ||
- can be built and published on [GitHub Pages]; | ||
- can be built and previewed locally, and published on other platforms. | ||
This Course is designed to provide students, who have already completed Advanced Programming and Discrete Structures, with a comprehensive understanding of fundamental concepts in computer science. The course begins with a focus on time and space complexity analysis, enabling students to grasp the theoretical underpinnings of algorithmic efficiency. Emphasis is placed on understanding how to assess the efficiency of algorithms in terms of their execution time and memory requirements, thus enabling students to make informed decisions about algorithm selection for various problem-solving scenarios. | ||
|
||
More specifically, the created site: | ||
Moving forward, the course delves into various essential data structures, including linked lists, stacks, queues, and heaps. Students gain a profound understanding of how these structures operate, as well as their advantages and limitations in different contexts. Additionally, the course explores advanced topics such as tree and graph traversal, covering both breadth-first and depth-first search algorithms, allowing students to comprehend the nuances of navigating complex data structures. This segment of the course provides a solid foundation for understanding more intricate concepts, such as binary search trees and balanced trees, fostering a deeper understanding of data organization and management. | ||
|
||
- uses a gem-based approach, i.e. uses a `Gemfile` and loads the `just-the-docs` gem; | ||
- uses the [GitHub Pages / Actions workflow] to build and publish the site on GitHub Pages. | ||
|
||
To get started with creating a site, simply: | ||
|
||
1. click "[use this template]" to create a GitHub repository | ||
2. go to Settings > Pages > Build and deployment > Source, and select GitHub Actions | ||
|
||
If you want to maintain your docs in the `docs` directory of an existing project repo, see [Hosting your docs from an existing project repo](#hosting-your-docs-from-an-existing-project-repo). | ||
|
||
After completing the creation of your new site on GitHub, update it as needed: | ||
|
||
## Replace the content of the template pages | ||
|
||
Update the following files to your own content: | ||
|
||
- `index.md` (your new home page) | ||
- `README.md` (information for those who access your site repo on GitHub) | ||
|
||
## Changing the version of the theme and/or Jekyll | ||
|
||
Simply edit the relevant line(s) in the `Gemfile`. | ||
|
||
## Adding a plugin | ||
|
||
The Just the Docs theme automatically includes the [`jekyll-seo-tag`] plugin. | ||
|
||
To add an extra plugin, you need to add it in the `Gemfile` *and* in `_config.yml`. For example, to add [`jekyll-default-layout`]: | ||
|
||
- Add the following to your site's `Gemfile`: | ||
|
||
```ruby | ||
gem "jekyll-default-layout" | ||
``` | ||
|
||
- And add the following to your site's `_config.yml`: | ||
|
||
```yaml | ||
plugins: | ||
- jekyll-default-layout | ||
``` | ||
Note: If you are using a Jekyll version less than 3.5.0, use the `gems` key instead of `plugins`. | ||
|
||
## Publishing your site on GitHub Pages | ||
|
||
1. If your created site is `YOUR-USERNAME/YOUR-SITE-NAME`, update `_config.yml` to: | ||
|
||
```yaml | ||
title: YOUR TITLE | ||
description: YOUR DESCRIPTION | ||
theme: just-the-docs | ||
url: https://YOUR-USERNAME.github.io/YOUR-SITE-NAME | ||
aux_links: # remove if you don't want this link to appear on your pages | ||
Template Repository: https://github.com/YOUR-USERNAME/YOUR-SITE-NAME | ||
``` | ||
|
||
2. Push your updated `_config.yml` to your site on GitHub. | ||
|
||
3. In your newly created repo on GitHub: | ||
- go to the `Settings` tab -> `Pages` -> `Build and deployment`, then select `Source`: `GitHub Actions`. | ||
- if there were any failed Actions, go to the `Actions` tab and click on `Re-run jobs`. | ||
|
||
## Building and previewing your site locally | ||
|
||
Assuming [Jekyll] and [Bundler] are installed on your computer: | ||
|
||
1. Change your working directory to the root directory of your site. | ||
|
||
2. Run `bundle install`. | ||
|
||
3. Run `bundle exec jekyll serve` to build your site and preview it at `localhost:4000`. | ||
|
||
The built site is stored in the directory `_site`. | ||
|
||
## Publishing your built site on a different platform | ||
|
||
Just upload all the files in the directory `_site`. | ||
|
||
## Customization | ||
|
||
You're free to customize sites that you create with this template, however you like! | ||
|
||
[Browse our documentation][Just the Docs] to learn more about how to use this theme. | ||
|
||
## Hosting your docs from an existing project repo | ||
|
||
You might want to maintain your docs in an existing project repo. Instead of creating a new repo using the [just-the-docs template](https://github.com/just-the-docs/just-the-docs-template), you can copy the template files into your existing repo and configure the template's Github Actions workflow to build from a `docs` directory. You can clone the template to your local machine or download the `.zip` file to access the files. | ||
|
||
### Copy the template files | ||
|
||
1. Create a `.github/workflows` directory at your project root if your repo doesn't already have one. Copy the `pages.yml` file into this directory. GitHub Actions searches this directory for workflow files. | ||
|
||
2. Create a `docs` directory at your project root and copy all remaining template files into this directory. | ||
|
||
### Modify the GitHub Actions workflow | ||
|
||
The GitHub Actions workflow that builds and deploys your site to Github Pages is defined by the `pages.yml` file. You'll need to edit this file to that so that your build and deploy steps look to your `docs` directory, rather than the project root. | ||
|
||
1. Set the default `working-directory` param for the build job. | ||
|
||
```yaml | ||
build: | ||
runs-on: ubuntu-latest | ||
defaults: | ||
run: | ||
working-directory: docs | ||
``` | ||
|
||
2. Set the `working-directory` param for the Setup Ruby step. | ||
|
||
```yaml | ||
- name: Setup Ruby | ||
uses: ruby/setup-ruby@v1 | ||
with: | ||
ruby-version: '3.1' | ||
bundler-cache: true | ||
cache-version: 0 | ||
working-directory: '${{ github.workspace }}/docs' | ||
``` | ||
|
||
3. Set the path param for the Upload artifact step: | ||
|
||
```yaml | ||
- name: Upload artifact | ||
uses: actions/upload-pages-artifact@v1 | ||
with: | ||
path: "docs/_site/" | ||
``` | ||
|
||
4. Modify the trigger so that only changes within the `docs` directory start the workflow. Otherwise, every change to your project (even those that don't affect the docs) would trigger a new site build and deploy. | ||
|
||
```yaml | ||
on: | ||
push: | ||
branches: | ||
- "main" | ||
paths: | ||
- "docs/**" | ||
``` | ||
|
||
## Licensing and Attribution | ||
|
||
This repository is licensed under the [MIT License]. You are generally free to reuse or extend upon this code as you see fit; just include the original copy of the license (which is preserved when you "make a template"). While it's not necessary, we'd love to hear from you if you do use this template, and how we can improve it for future use! | ||
|
||
The deployment GitHub Actions workflow is heavily based on GitHub's mixed-party [starter workflows]. A copy of their MIT License is available in [actions/starter-workflows]. | ||
|
||
---- | ||
|
||
[^1]: [It can take up to 10 minutes for changes to your site to publish after you push the changes to GitHub](https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/creating-a-github-pages-site-with-jekyll#creating-your-site). | ||
|
||
[Jekyll]: https://jekyllrb.com | ||
[Just the Docs]: https://just-the-docs.github.io/just-the-docs/ | ||
[GitHub Pages]: https://docs.github.com/en/pages | ||
[GitHub Pages / Actions workflow]: https://github.blog/changelog/2022-07-27-github-pages-custom-github-actions-workflows-beta/ | ||
[Bundler]: https://bundler.io | ||
[use this template]: https://github.com/just-the-docs/just-the-docs-template/generate | ||
[`jekyll-default-layout`]: https://github.com/benbalter/jekyll-default-layout | ||
[`jekyll-seo-tag`]: https://jekyll.github.io/jekyll-seo-tag | ||
[MIT License]: https://en.wikipedia.org/wiki/MIT_License | ||
[starter workflows]: https://github.com/actions/starter-workflows/blob/main/pages/jekyll.yml | ||
[actions/starter-workflows]: https://github.com/actions/starter-workflows/blob/main/LICENSE | ||
Moreover, the course delves into essential sorting algorithms, equipping students with the skills to compare and contrast various sorting techniques based on their efficiency and applicability in different scenarios. The students also learn about the principles of hashing and its practical applications in data retrieval and storage. The course culminates with a comprehensive study of shortest path algorithms, focusing on Dijkstra's and Bellman-Ford algorithms, enabling students to grasp the intricacies of pathfinding in a variety of network structures. By the end of the course, students are well-prepared to tackle real-world problems that require a solid understanding of data structure and algorithmic principles. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
--- | ||
title: Week 1 Announcement | ||
week: 1 | ||
date: 2023-10-15 | ||
--- | ||
|
||
Welcome to DA course. please join the [quera](https://quera.org/) to submit the assignments. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
--- | ||
title: Assignment 1 | ||
topic: Divide and Conquer, Amortized, Time Complexity | ||
pdf: ../assets/assignments/E1.pdf | ||
--- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
--- | ||
title: Assignment 2 | ||
topic: Linked List, Queue, Stack, Tree | ||
pdf: ../assets/assignments/E2.pdf | ||
--- |
Oops, something went wrong.