GithubHelp home page GithubHelp logo

pedroth / pedroth.github.io Goto Github PK

View Code? Open in Web Editor NEW
2.0 1.0 0.0 1.12 GB

Pedroth's web corner

Home Page: http://pedroth.github.io

License: MIT License

HTML 12.87% JavaScript 86.83% CSS 0.23% Batchfile 0.05% Shell 0.02%

pedroth.github.io's Introduction

Pedroth's Corner

Website where I share some notes and projects about topics I like.

Check here

Concept

Pedroth's Corner is my personal website. Here I will:

  • Write about things I like
  • Distill knowledge
  • Showcase demos and software projects
  • I will also share my contact and places on the web, such as youtube, github, twitter, etc...

Features

  • All post will be organized by:
    • Set of tags (similar post should have common tags)
    • Creation and update date
    • Title
  • Search engine
    • Search by title and tag
  • Visual post representation
  • Posts written in nabladown.js
  • Minimal dependencies
  • Minimalistic design
  • Visual representation of tags

Architecture

Folder Structure

  • /assets
  • /database
  • /feed
  • /lib
  • /others
  • /posts
  • /scripts
  • /src
  • .eslintrc.yml
  • .gitignore
  • bundle.js
  • favicon.ico
  • index.css
  • index.html
  • index.js
  • package.json
  • README.md

DB Structure

DB := {
    posts: Array<Post>
}

Post := {
	id: String,
	title: String,
	creationDate: String<Date: dd/mm/yyyy>,
	lastUpdateDate: String<Date: dd/mm/yyyy>,
	tags: Array<String>
}

Js first

It will be a single page application using vanilla js, described here

Scripts

Most of the useful scripts can be found in the package.json, scripts section. Therefore you should run those, by using bun run ... or node run ...<name of script>.

If you really need to run the scripts you need to run it from the root ./, like this:

sh scripts/...

or

bun scripts/...

or

node scripts/...

The scripts/blog-builder.js build-java only run using node, there is a bug in bun that blocks running this particular command.

Dependencies

General dependencies

Js dependencies

  • nabladown.js
  • textFit

Using Blog Builder

The blog builder is a set of scripts designed to update the website. It updates the database, creates the images in various resolutions, create/updates various artifacts (e.g the build-java script)

Creating a new post

  • Create new folder with the unique id of the post in posts folder
  • Inside this folder create a .nd file with the name equal to its unique id
  • The first lines the .nd file, should be a comment with the following format:
    • title: String
    • creationDate: String<Date: dd/mm/yyyy> (note: dd=00..31 / mm=01..12 / yyyy=0000....9999)
    • lastUpdateDate: String<Date: dd/mm/yyyy>
    • tags: Array
  • Add .webm video about your post with its name equal to its unique id
  • Run bun run build-posts in the root.

TODO

  • Add different view on tags (like this)
  • Add email subscription (?)

pedroth.github.io's People

Contributors

dependabot[bot] avatar pedrocristovao-movai avatar pedroth avatar

Stargazers

 avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.