update

Author: sofiaoreis

README.md

@@ -1,73 +1,51 @@
-# Welcome to your Lovable project
+# security-commits.org
 
-## Project info
+[![Security Commits](https://img.shields.io/badge/Security%20Commits-1.0.0-%23FE5196?logo=conventionalcommits&logoColor=white)](https://security-commits.org)
 
-**URL**: https://lovable.dev/projects/6afe7763-2aeb-46a8-9748-35b98b5fb3e3
+This repo is the home of the [SECOM specification](https://security-commits.org).
 
-## How can I edit this code?
+## Repo Layout
 
-There are several ways of editing your application.
+We use [HUGO](https://gohugo.io/) as static site generator, so we use the [directory structure](https://gohugo.io/getting-started/directory-structure/) HUGO proposes.
 
-**Use Lovable**
+#### Our implementation
 
-Simply visit the [Lovable Project](https://lovable.dev/projects/6afe7763-2aeb-46a8-9748-35b98b5fb3e3) and start prompting.
+* `./content`: contains all the versions of the specification.
+* `./content/next/`: contains the version of the specification (where all the changes SHOULD be made).
+* `./content/**/index.[lang].md`: contains the content of the specification, if a language is specified it's a translation.
 
-Changes made via Lovable will be committed automatically to this repo.
+## Contributing
 
-**Use your preferred IDE**
+We'd love your help refining the language of this specification,
+fixing typos, or adding more translations. Please don't hesitate
+to send a pull request.
 
-If you want to work locally using your own IDE, you can clone this repo and push changes. Pushed changes will also be reflected in Lovable.
+### Adding a translation
 
-The only requirement is having Node.js & npm installed - [install with nvm](https://github.com/nvm-sh/nvm#installing-and-updating)
+1. Create a new file in `./content/version/index.[lang].md` using the hugo command `hugo new [version]/index.[lang].md`.
+1. Ensure all files have the appropriate fields required (see others as an example)..
+1. Add the language to the `config.yaml` file (see others as an example).
 
-Follow these steps:
+### Running project locally
 
-```sh
-# Step 1: Clone the repository using the project's Git URL.
-git clone <YOUR_GIT_URL>
+There's a docker-compose.yml file ready that will help you to check if the website looks good!
+To run it make sure you have [docker-compose installed](https://docs.docker.com/compose/install/#install-compose) on your machine and just use the command `docker-compose up` to make it run locally.
 
-# Step 2: Navigate to the project directory.
-cd <YOUR_PROJECT_NAME>
+Once the website will be compiled, you can see the website visiting `http://localhost:1313`
 
-# Step 3: Install the necessary dependencies.
-npm i
+## Badges!
 
-# Step 4: Start the development server with auto-reloading and an instant preview.
-npm run dev
-```
-
-**Edit a file directly in GitHub**
-
-- Navigate to the desired file(s).
-- Click the "Edit" button (pencil icon) at the top right of the file view.
-- Make your changes and commit the changes.
-
-**Use GitHub Codespaces**
-
-- Navigate to the main page of your repository.
-- Click on the "Code" button (green button) near the top right.
-- Select the "Codespaces" tab.
-- Click on "New codespace" to launch a new Codespace environment.
-- Edit files directly within the Codespace and commit and push your changes once you're done.
+Tell your users that you use the Conventional Commits specification:
 
-## What technologies are used for this project?
-
-This project is built with:
-
-- Vite
-- TypeScript
-- React
-- shadcn-ui
-- Tailwind CSS
-
-## How can I deploy this project?
-
-Simply open [Lovable](https://lovable.dev/projects/6afe7763-2aeb-46a8-9748-35b98b5fb3e3) and click on Share -> Publish.
+```markdown
+[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-%23FE5196?logo=conventionalcommits&logoColor=white)](https://conventionalcommits.org)
+```
 
-## Can I connect a custom domain to my Lovable project?
+## Thank you
 
-Yes, you can!
+To **[Lorenzo D'Ianni](https://github.com/lorenzodianni)** for the great effort creating the CSS and the HTML for the new UI.
 
-To connect a domain, navigate to Project > Settings > Domains and click Connect Domain.
+To **[Netlify](https://www.netlify.com/)** to host our project, giving us a lot of [amazing built in functionality](https://www.netlify.com/features/) for free.
 
-Read more here: [Setting up a custom domain](https://docs.lovable.dev/tips-tricks/custom-domain#step-by-step-guide)
+To **[semver.org](https://github.com/mojombo/semver.org)**: we used [semver.org](https://github.com/mojombo/semver.org) as a blueprint for
+the structure of this specification and the first version of the website.

docs/assets/index-mvUZ7FOg.css renamed to docs/assets/index-C6IzIce3.css

@@ -6,7 +6,7 @@
     <title>Security Commits</title>
     <meta name="description" content="A convention and set of best practices for security commit messages." />
     <meta name="author" content="Sofia Reis" />
-    <link rel="icon" href="/security-commits.github.io/favicon.ico" />
+    <link rel="icon" href="//refs/heads/main/docs/favicon.ico" />
 
     <meta property="og:title" content="Security Commits" />
     <meta property="og:description" content="A convention and set of best practices for security commit messages." />
@@ -16,8 +16,8 @@
     <meta name="twitter:card" content="summary_large_image" />
     <meta name="twitter:site" content="" />
     <meta name="twitter:image" content="" />
-    <script type="module" crossorigin src="/security-commits.github.io/assets/index-B_3GW_6-.js"></script>
-    <link rel="stylesheet" crossorigin href="/security-commits.github.io/assets/index-mvUZ7FOg.css">
+    <script type="module" crossorigin src="/assets/index-CBP-egic.js"></script>
+    <link rel="stylesheet" crossorigin href="/assets/index-C6IzIce3.css">
   </head>
 
   <body>

docs/assets/index-B_3GW_6-.js renamed to docs/assets/index-CBP-egic.js

@@ -6,7 +6,7 @@
     <title>Security Commits</title>
     <meta name="description" content="A convention and set of best practices for security commit messages." />
     <meta name="author" content="Sofia Reis" />
-    <link rel="icon" href="%BASE_URL%favicon.ico" />
+    <link rel="icon" href="%BASE_URL%/refs/heads/main/docs/favicon.ico" />
 
     <meta property="og:title" content="Security Commits" />
     <meta property="og:description" content="A convention and set of best practices for security commit messages." />

docs/index.html

@@ -31,7 +31,7 @@ const Header = () => {
         <div className="flex items-center justify-between h-16">
           <div className="flex items-center">
             <Link to="/" className="text-primary font-bold text-xl">
-              <span className="text-yellow-500">SEC</span>URITY <span className="text-yellow-500">CdOM</span>MITS
+              SECURITY COMMITS
             </Link>
           </div>
 
@@ -50,15 +50,15 @@ const Header = () => {
 
             <Link to="/convention" className="text-foreground hover:text-primary transition-colors">Convention</Link>
 
-            {isHomePage ? (
+            {/* {isHomePage ? (
               <a href="#examples" className="text-foreground hover:text-primary transition-colors">Examples</a>
             ) : (
               <Link to="/" className="text-foreground hover:text-primary transition-colors">Examples</Link>
-            )}
+            )} */}
 
             {/* <Link to="/reference" className="text-foreground hover:text-primary transition-colors">Reference</Link> */}
 
-            <Link to="/blog" className="text-foreground hover:text-primary transition-colors">Blog</Link>
+            {/* <Link to="/blog" className="text-foreground hover:text-primary transition-colors">Blog</Link> */}
 
             <Link to="/docs" className="text-foreground hover:text-primary transition-colors">Docs</Link>
 

index.html

@@ -1,4 +1,3 @@
-
 import { Button } from '@/components/ui/button';
 import { FiArrowDown, FiGithub } from 'react-icons/fi';
 
@@ -10,7 +9,8 @@ const Hero = () => {
           <div className="mx-auto max-w-7xl px-6 lg:px-8">
             <div className="mx-auto max-w-2xl text-center">
               <h1 className="text-4xl font-bold tracking-tight sm:text-6xl">
-                <span className="text-primary">SECOM</span>: Security Commit Message Convention
+                <span className="text-primary">SECOM</span><br />
+                <span className="text-4xl">Security Commit Message Convention</span>
               </h1>
               <p className="mt-6 text-lg leading-8 text-muted-foreground">
                 <strong>A standardized way to document security changes in your commit messages</strong>
@@ -21,11 +21,10 @@ const Hero = () => {
                 <Button size="lg" className="flex items-center gap-2" asChild>
                   <a href="/convention">
                     Get Started
-                    <FiArrowDown className="ml-1" size={16} />
                   </a>
                 </Button>
                 <Button variant="outline" size="lg" className="flex items-center gap-2" asChild>
-                  <a href="https://github.com/security-commits/secom" target="_blank" rel="noopener noreferrer">
+                  <a href="https://github.com/security-commits/" target="_blank" rel="noopener noreferrer">
                     <FiGithub size={16} />
                     View on GitHub
                   </a>

src/components/Header.tsx

@@ -5,7 +5,7 @@ import { componentTagger } from "lovable-tagger";
 
 // https://vitejs.dev/config/
 export default defineConfig(({ mode }) => ({
-  base: "/security-commits.github.io/",
+  base: "/",
   server: {
     host: "::",
     port: 8080,