ck-lamib / website-my

Website

This website is built using Docusaurus 2, a modern static website generator.

Installation

$ yarn

Local Development

$ yarn start

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

Build

$ yarn build

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

Deployment

Using SSH:

$ USE_SSH=true yarn deploy

Not using SSH:

$ GIT_USER=<Your GitHub username> 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.

---

++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

How to use this webiste to update content???

---

How to add Blog in existing Blog folder?

1. Select either technical or extra Blog inside the blog folder
2. Inside this folder you will see another folder on which you need to add content
3. Make a file in the folder with date(y-m-d)-blogtitle.md
4. Save the file
5. You are good to go

---

How to add blog folder in technical or extra blog?

To do this you need to do 3 steps described below:

1. Create folder and file inside technical or extra in blog folder

   

2. Create currently created folders plugins giving routeBasePath and path in docusarous.config.js file

   

3. Now fill the data of the blog inside data/blogContent

   

4. You are good to go

---

How to add blog like technical and extra

You can do it in 2 ways:

1. Add a blog page that will display all the blog directly to the page even if it is inside the folder:

   a. Create a folder(raw) which contains folder(optional) and files inside blog folder:

   

   b. Now add information about blog page in blogstart.js file present inside data/blogCotent

   Note: (blogName(folder name), descriptive image(static/img/blogstart), slug(pointing to folderPath(raw)))

   

   c. To point slug towards the raw folder you have to create blog plugin(for multiple blog). To do so add plugins inside docusaurs.config.js file

   

   Final result:

   

   Note: the files inside rawDemo folder is also displalyed here.

2. Add a blog page that will display all the blog according to folder present

   (Note all files directly present in root folder(raw in our case) will be excluded)

   a. Create a folder(raw) which contains another folder containing files inside blog folder. All of the file should be inside certain folder inside raw folder.

   b. To display each folder u have to create interface first and then link the folder path to the interface link create {name}BlogCard folder

   

   c. Create {name}BlogCard.js file inside data/blogContent folder and add the blog information(title(folder heading i.e. rawDemo in our case which is inside raw folder), descriptive image(tatic/img/blogstart), slug(pointing to folderPath(demoRaw))

   

   d. To point slug towards the raw folder you have to create blog plugin same like above inside docusaurs.config.js file

   e. Now point the data of {name}BlogCard.js to index.js of {name}BlogCard folder

   

   f. After doing this the last step is to add information about the {name}BlogCard folder to the blogstart.js page same like above

---

How to add projects???

1. Create projectName.js file inside pages/projects folder and rename the slug to file name

   

2. Now add the information about the project in project.js file inside data folder

   Note: the slug should be all same and image to be stored in static/img/projects

   

3. You are good to go