Nikurasu/socialtree-jigsaw
Archived
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
No description
This repository has been archived on 2022-11-29. You can view files and clone it, but cannot push or open issues or pull requests.
21 commits 1 branch 0 tags 2 MiB
SCSS 74.1%
Blade 21%
PHP 2.7%
JavaScript 2.2%
Find a file
nikurasu b75f7c63b4 Typo in readme
2022-07-24 17:03:06 +02:00
examples/images Renamed picture 2022-05-04 13:11:59 +02:00
source Removed the color property, the platform property is now used for the link coloring 2022-07-24 17:00:45 +02:00
.gitignore Made a config.php.example 2022-04-30 22:41:25 +02:00
bootstrap.php First Commit 2022-04-29 15:25:15 +02:00
composer.json First Commit 2022-04-29 15:25:15 +02:00
config.php.example Removed the color property from config.php.example 2022-07-24 17:01:53 +02:00
config.production.php First Commit 2022-04-29 15:25:15 +02:00
package.json First Commit 2022-04-29 15:25:15 +02:00
README.md Typo in readme 2022-07-24 17:03:06 +02:00
webpack.mix.js Added new theme: 95.scss 2022-05-04 13:04:24 +02:00

README.md

SocialTree

A simple way to show your links

This is a very simple static site generator for listing the links for your social media channels.

Sounds great but how do I use it?

It's very simple, follow these steps.

  1. Install PHP and Node.js
  2. Download the Project as zip or clone it
  3. Run composer install and npm install
  4. Edit the config.php file:

    • The author is the displayed name

    • The imageName should be the file name of the image you are using, the file itself should be placed in source/assets/images

    • The design refers to the style of your page the currently available styles are:

    • List as much links as you like in the links array:

      • With the platform property you can give the link the color of the social media plaform of your choice, but this feature is optional, the link will be displayed in the themes color if unset. This is currently only supported by themes which dont look ugly with that:
        • blurywhite

      The currently supported platforms are:

      • YouTube, Pinterest, Twitter, TikTok, Telegram, Linkedin, Mastodon, Tumblr, Discord, Twitch, Instagram, Flickr, Deviantart, Spotify, Snapchat, Reddit, Soundcloud, VK, Steam
      • You can give the link a different text if you want with the text property. It displays the platform set in the platform property normaly, but with that propery you can overwrite that.
      • If you don't want a platform color for a theme wich supports it. simply unset the platform property, but then you have to set the text property to get the link displayed.
      • Place the link in the link property, this property is needed.
  5. Compile the page with the command: npm run prod
  6. Copy the build_production directory to your webserver.

TODO

  • More themes

example.jpg by Yaka Bagus from Pexels:

https://www.pexels.com/photo/woman-in-costume-holding-a-swim-ring-while-standing-on-wooden-dock-9692281/