Skip to content

Commit

Permalink
updated website
Browse files Browse the repository at this point in the history
  • Loading branch information
AryanKoundal committed Apr 3, 2023
0 parents commit 5fed653
Show file tree
Hide file tree
Showing 74 changed files with 34,380 additions and 0 deletions.
21 changes: 21 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Dependencies
/node_modules

# Production
/build

# Generated files
.docusaurus
.cache-loader

# Misc
.env
.DS_Store
.env.local
.env.development.local
.env.test.local
.env.production.local

npm-debug.log*
yarn-debug.log*
yarn-error.log*
1 change: 1 addition & 0 deletions .tool-versions
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
nodejs 19.3.0
33 changes: 33 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Website

This website is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator.

## Installation

```console
yarn install
```

## Local Development

```console
yarn start
```

This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.

## Build

```console
yarn build
```

This command generates static content into the `build` directory and can be served using any static contents hosting service.

## Deployment

```console
GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy
```

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
3 changes: 3 additions & 0 deletions babel.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
module.exports = {
presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
};
13 changes: 13 additions & 0 deletions blog/2023-02-23-sample-blog.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
title: This is the title of the blog
author: Aryan Koundal
author_url: https://github.com/AryanKoundal
author_title: Pre-Final year Computer Science and Engg Student at NIT Hamirpur
author_image_url: https://github.com/AryanKoundal.png
tags: [tag1, tag2, tag3, tag4]
---

This is the summary
<!--truncate-->

This is the content
76 changes: 76 additions & 0 deletions blog/2023-02-28-docusaurus-gh-action.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
---
title: Deployment blog
author: Aryan Koundal
author_url: https://github.com/AryanKoundal
author_title: Pre-Final year Computer Science and Engg Student at NIT Hamirpur
author_image_url: https://github.com/AryanKoundal.png
tags: [tag1, tag2, tag3, tag4]
---

I got tired of deploying my Docusaurus website to GitHub Pages manually, and decided to do something about it using GitHub Action.

Initially, I was planning to follow the [official guide](https://v2.docusaurus.io/docs/deployment#triggering-deployment-with-github-actions) on doing so. However, it was actually much more complicated than I liked. I did not really want to generate and store a SSH key on GitHub. Too much effort man.

I decided it was better off for me to write my own script. Here it is:

<!--truncate-->

## deploy-docusaurus.yml

:::caution

The script below assumes that your Docusaurus website resides at `/website` of your repo. If that is not the case for you, you will need to:

- Change `cd website` to `cd <docu_site_root>`, or delete the entire line if your Docusaurus website is at the root of your repo `/`
- Change `build_dir`'s value from `website/build` to `<docu_site_root>/build`, or `build` if your Docusaurus website is at the root of your repo `/`

:::

```yml
name: deploy-docusaurus

on:
push:
branches: [main]
pull_request:
branches: [main]

# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

# A workflow run is made up of one or more jobs that can run sequentially or in parallel
jobs:
publish:
runs-on: ubuntu-latest
steps:
# Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
- name: Check out repo
uses: actions/checkout@v2
# Node is required for npm
- name: Set up Node
uses: actions/setup-node@v2
with:
node-version: "12"
# Install and build Docusaurus website
- name: Build Docusaurus website
run: |
cd website
npm install
npm run build
- name: Deploy to GitHub Pages
if: success()
uses: crazy-max/ghaction-github-pages@v2
with:
target_branch: gh-pages
build_dir: website/build
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
```
:::note
GitHub will automatically add `GITHUB_TOKEN` to Secrets. You need not do so. See [this](https://docs.github.com/en/actions/reference/authentication-in-a-workflow) for more information.

:::

To see this script in action, visit my [personal website repo](https://github.com/AryanKoundal/kaya-folio/actions).
39 changes: 39 additions & 0 deletions docs/c-cheatsheet.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
title: C Cheatsheet
---

Published on December 23, 2020

_This document was migrated from [DigiDocs](https://digipie.github.io/digidocs/c/arguments/)_

## Print out arguments

The example program below prints out all command line arguments passed into the `main()` function.

**print-arguments.c**

```c
#include <stdio.h>

int main(int argc, char **argv) {
for (int i = 0; i < argc; i++) {
printf("%s\n", argv[i]);
}
}
```
Key details:
- `argc` - the number of arguments passed into the program
- `argv` - the array of character pointers (strings) containing all arguments
- `argv[0]` - the first argument which is also the name of the program
To use:
- Enter the above code into a file (e.g. `print-arguments.c`).
- Compile the code with `gcc print-arguments.c -o print-arguments`.
- Run the executable with `./print-arguments test` or `./print-arguments $USER`.
## Resources
- [Original copy of this document at DigiDocs](https://digipie.github.io/digidocs/c/arguments/)
82 changes: 82 additions & 0 deletions docs/contents.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
---
title: Contents
slug: "/"
---

Last Updated on March 30, 2023

## Reading List

Here, you will find my thoughts on articles, books, videos and other forms of media. I also maintain a [Reading List](reading-list) of articles, books, videos, and more which I think are meaningful and insightful.

### Article Summaries
<!--
<div class="contentTableContainer">
| | Topic | Date Last Updated |
| --- | ------------------------------------------------------------------------ | ----------------- |
| 1 | [Name of Topic ](scaling-memcached) | March 30, 2023 |
</div> -->

### Book Summaries

<div class="contentTableContainer">

| | Title | Date Last Updated |
| --- | ----------------------------------------------------------------------- | ----------------- |
| 1 | [Ikigai: The Japanese Secret to a Long and Happy Life](ikigai) | March 30, 2023 |

</div>

## Documentation

Here, you will find a collection of concise notes on full-stack software engineering and cloud operations. These notes are filed under their respective topic, with related topics are categorised under the same chapter.
<!--
### Cloud and Networking
<div class="contentTableContainer">
| | Topic | Date Last Updated |
| --- | ------------------------------ | ----------------- |
| 1 | [Docker](docker-cheatsheet) | December 24, 2020 |
| 2 | [GCP GKE](gcp-gke-cheatsheet) | December 24, 2020 |
| 3 | [Mininet](mininet-setup) | December 27, 2020 |
| 4 | [Network Model](network-model) | November 30, 2020 |
</div> -->

### Programming

<div class="contentTableContainer">

| | Topic | Date Last Updated |
| --- | ---------------------------- | ----------------- |
| 1 | [C](c-cheatsheet) | March 30, 2023 |
| 2 | [Javascript](js-cheatsheet) | March 30, 2023 |

</div>

### Tooling and OS

<div class="contentTableContainer">

| | Topic | Date Last Updated |
| --- | ------------------------------ | ----------------- |
| 1 | [Git](git-cheatsheet) | March 30, 2023 |
| 2 | [Ubuntu](os-ubuntu-cheatsheet) | March 30, 2023 |

</div>

### Web Development

<div class="contentTableContainer">

| | Topic | Date Last Updated |
| --- | ---------------------------- | ----------------- |
| 1 | [MongoDB](mongodb-setup) | March 30, 2023 |
| 2 | [NodeJS](nodejs-auto-reload) | March 30, 2023 |
| 3 | [Django](django-setup) | March 30, 2023 |


</div>
Empty file added docs/django-setup.md
Empty file.
Loading

0 comments on commit 5fed653

Please sign in to comment.