{"id":21043602,"url":"https://github.com/bradeneverson/sitesmith","last_synced_at":"2025-05-15T17:31:58.741Z","repository":{"id":244315616,"uuid":"814894632","full_name":"BradenEverson/sitesmith","owner":"BradenEverson","description":"Automated parser CLI tool to generate my personal website dynamically :)","archived":false,"fork":false,"pushed_at":"2024-06-22T01:59:20.000Z","size":16,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-30T03:03:39.054Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/BradenEverson.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-06-14T00:00:19.000Z","updated_at":"2024-10-28T15:23:05.000Z","dependencies_parsed_at":"2024-06-14T01:28:00.680Z","dependency_job_id":"7d200467-c1fc-46fb-bf72-59a6d91ed4ef","html_url":"https://github.com/BradenEverson/sitesmith","commit_stats":null,"previous_names":["bradeneverson/sitesmith"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BradenEverson%2Fsitesmith","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BradenEverson%2Fsitesmith/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BradenEverson%2Fsitesmith/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BradenEverson%2Fsitesmith/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/BradenEverson","download_url":"https://codeload.github.com/BradenEverson/sitesmith/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254388172,"owners_count":22063000,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-19T14:13:23.935Z","updated_at":"2025-05-15T17:31:58.423Z","avatar_url":"https://github.com/BradenEverson.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# SiteSmith 🛠️\n[![crates.io](https://img.shields.io/crates/v/sitesmith.svg)](https://crates.io/crates/sitesmith)\n\nSiteSmith is a Rust CLI tool designed to generate a personal website. It reads project and work experience data from JSON files and uses a template to create an HTML website.\n\n## Features\n\n- Parses JSON data for projects and work experience.\n- Utilizes an HTML template to format and generate the website.\n- Customizable templates for projects and work entries.\n\n## Installation\n\n1. Ensure you have [Rust](https://www.rust-lang.org/tools/install) installed.\n2. Install SiteSmith using Cargo:\n\n```bash\ncargo install sitesmith\n```\n\n## Usage\n\nTo generate your website, run the `sitesmith` CLI tool with the following arguments:\n\n```bash\nsitesmith --projects \u003cprojects.json\u003e --work \u003cwork.json\u003e --template \u003ctemplate.html\u003e --output \u003coutput.html\u003e\n```\n\n### Arguments\n\n- `--projects`: Path to the JSON file containing project data.\n- `--work`: Path to the JSON file containing work experience data.\n- `--template`: Path to the HTML template file.\n- `--output`: Path to the output HTML file to be generated.\n\n### Example\n\n```bash\nsitesmith --projects projects.json --work work.json --template template.html --output index.html\n```\n\n## JSON Data Format\n\n### Projects JSON Format\n\nThe projects JSON file should contain an array of project entries. Each entry should have the following structure:\n\n```json\n[\n    {\n        \"name\": \"Project Name\",\n        \"descr\": [\"Project description item 1\", \"Project description item 2\"],\n        \"extra\": [\"\u003cp\u003eAdditional project information\u003c/p\u003e\"]\n    },\n    ...\n]\n```\n\n### Work Experience JSON Format\n\nThe work JSON file should contain an array of work experience entries. Each entry should have the following structure:\n\n```json\n[\n    {\n        \"name\": \"Job Title\",\n        \"timespan\": \"Duration\",\n        \"location\": \"Location\",\n        \"descr\": [\"Job description item 1\", \"Job description item 2\"],\n        \"extra\": [\"\u003cp\u003eAdditional job information\u003c/p\u003e\", \"\u003cb\u003eEven more job info!\u003c/b\u003e\"]\n    },\n    ...\n]\n```\n\n## HTML Template\n\nThe HTML template should include placeholders for the projects and work experience sections. For example:\n\n```html\n\u003c!DOCTYPE html\u003e\n\u003chtml\u003e\n\u003chead\u003e\n    \u003ctitle\u003eMy Personal Website\u003c/title\u003e\n    \u003clink rel=\"stylesheet\" type=\"text/css\" href=\"style.css\"\u003e\n\u003c/head\u003e\n\u003cbody\u003e\n    \u003cheader\u003e\n        \u003ch1\u003eWelcome to My Personal Website\u003c/h1\u003e\n    \u003c/header\u003e\n    \u003cmain\u003e\n        \u003csection id=\"projects\"\u003e\n            {projects}\n        \u003c/section\u003e\n        \u003csection id=\"work\"\u003e\n            {work}\n        \u003c/section\u003e\n    \u003c/main\u003e\n    \u003cfooter\u003e\n        \u003cp\u003e© 2024 Your Name\u003c/p\u003e\n    \u003c/footer\u003e\n\u003c/body\u003e\n\u003c/html\u003e\n```\n\nThe placeholders `{projects}` and `{work}` will be replaced with the generated HTML content for the projects and work experience respectively.\n\n## Example\n\nYou can see a live example of a website generated using SiteSmith [here](https://bradeneverson.github.io/).\n\nThe source code for this example is available on GitHub: [bradeneverson.github.io](https://github.com/BradenEverson/bradeneverson.github.io).\n\n\n## Contributing\n\n1. Fork the repository.\n2. Create a new branch (`git checkout -b feature-branch`).\n3. Make your changes.\n4. Commit your changes (`git commit -am 'Add new feature'`).\n5. Push to the branch (`git push origin feature-branch`).\n6. Create a new Pull Request.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbradeneverson%2Fsitesmith","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbradeneverson%2Fsitesmith","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbradeneverson%2Fsitesmith/lists"}