Joao-S-Martins / Joao-Eye-Oh

Personal photo journal and blog

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Website

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

Scripts & Tools

Installation

$ npm

Set NVM Version

Open Git Bash with administrative privileges.

$ nvm use 18.5.0

Local Development

$ npm 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

$ npm run build

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

Screeshot Testing

$ yarn screenshots

This will build before testing.

Deployment

Using SSH:

$ USE_SSH=true npm run 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. View the site at https://joao-s-martins.github.io/Joao-Eye-Oh/. If there seems to be an issue, check the deployment page.

Ideal Image

import Image from '@theme/IdealImage';
import thumbnail from './path/to/img.png';

// your React code
<Image img={thumbnail} />

// or
<Image img={require('./path/to/img.png')} />

References

Inspirations

About

Personal photo journal and blog


Languages

Language:TypeScript 47.2%Language:JavaScript 21.0%Language:SCSS 13.5%Language:CSS 12.3%Language:MDX 6.1%