Skip to content

devnyxie/nyxie-taut

Repository files navigation

Nyxie-taut

A Nyxie-taut template serves as a ready-made and pre-configured web development project, providing a solid starting point for creating blogs,portfolio websites or web-based CVs.

Filled template:


Customization:

  1. Press "Fork" the repository
  2. If you want to deploy it to Github Pages, please name it like that: username.github.io, for example: devnyxie.githib.io
  3. Profile customization:
    1. Open src/personalization/profile.json
    2. Change to your name, enter your bio, and enter social media usernames if you have any.
    3. Put image of your choice in src/images/ as profile_picture.jpg
  4. Site customization:
    1. Open src/personalization/site.json
    2. Change site name, description etc. You have ability to choose any Google Font you like, for example: "Playpen Sans", "Poppins", "Montserrat". Keep in mind that font name is case sensetive.
    3. Replace favicon.ico in folder "static".
  5. Blog/Projects
    1. Open src/content/blog or src/content/projects
    2. Drop your projects/blogs in markdown in these folders, and they will be automatically grabbed in build time.
      Note:
      Please use this format for your blog/projects: date+title.md.
      Example: 2023-09-01-my-blog.md
  6. This is it. It's ready for production! Create an account on any hosting platform like Vercel, choose repository you want to deploy and wait a minute until it's deployed.

Deploying to Github Pages:

  1. Name your forked repository as username.github.io as we have mentioned before.
  2. Enable the workflows:
  3. Head over to settings of your forked repository to enable Github Pages (don't forget to click "Save"!):
  4. Select Gatsby workflow and click Run workflow:
  5. An action will start which will take up to 2 minutes. After, your website must be already live at https://username.github.io 🤍
Thank you!
Feel free to star the repository 🤍

What is a Gatsby template?

Gatsby is a popular open-source framework known for creating fast and efficient websites. In the world of Gatsby, templates are like starter kits that come with ready-made files, settings, and often a basic structure. They provide a solid starting point for web developers, making it easier to begin their projects. These templates can be customized to fit a project's specific needs, making it quicker to start development.

In simple terms, Gatsby takes your content and turns it into a static website. It uses nodes and GraphQL to efficiently fetch and display data. Plus, it allows you to host your website for free using static site hosting services (for example: Vercel, Github Pages, Netlify). This makes hosting easy, resulting in speedy, cost-effective, and low-maintenance websites.


For further insights on how Gatsby blogs operate, you can refer to the documentation provided here: How Gatsby Blogs Work 🔗


Special Thanks

This project would have been much more challenging without Nikola Đuza's invaluable tutorial on building a Gatsby blog from the ground up, which you can find here.