Skip to content

docwire/docwire.io

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

147 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Docwire Website

This repository contains the source code for the Docwire website. It is built to be easily editable directly through GitHub.

🚀 How to Update the Site

You do not need to install any software on your computer. You can edit files directly in your web browser.

  1. Edit: Navigate to the file you want to change on GitHub and click the Pencil icon (Edit this file).
  2. Save: Scroll to the bottom, add a short description of your change, and click Commit changes.
  3. Deploy: The website will automatically rebuild and update within a few minutes. You can check the progress in the Actions tab.

📝 Editing Content

1. Homepage Text

The homepage is made up of several sections. You can find the text for these sections in the src/containers folder.

  • Hero (Top Section): src/containers/header/home/HomeHeader.jsx
  • "Have you ever wanted to...": src/containers/components/home/HomeHaveYouEver.jsx
  • "Unlock the Power" Cards: The content for these cards is in src/data/unlockThePowerData.js.
  • Wings Section: src/containers/components/home/WingsSection.jsx
  • Call to Action (Bottom): src/containers/CTA/CTA.jsx
  • Supported Formats Grid: The list of formats is in src/data/supportedFormatsData.js.

Tip: Look for the white text inside the code. Be careful not to delete code symbols like <p>, <h3>, </div>, or {.

2. Blog Posts

Blog posts are located in the blog/ folder.

To add a new post:

  • Text-only: Create a new file in blog/ (e.g., blog/2024-01-01-my-post.md).
  • With Images: Create a new folder (e.g., blog/2024-01-01-my-post) and add an index.md file inside.

Paste the following template at the top of your file:

```markdown
---
title: My New Post Title
authors: ferid
tags: [news, update]
---

Write your introduction here.

<!--truncate-->

Write the rest of your post here.
```

Adding Images & Videos

  • Images:

    • Option 1 (Post-Specific): Place the image in the same folder as your Markdown file.
      ![Description](./your-image-name.jpg)
    • Option 2 (Shared/Reusable): If an image is used on multiple pages, upload it to static/img/. Reference it using the full path so it works in GitHub:
      ![Description](/static/img/your-image.jpg)
  • YouTube: Simply add a standard image link pointing to the YouTube video. The website will automatically convert this into a video player.

    [![Video title](https://img.youtube.com/vi/VIDEO_ID/hqdefault.jpg)](https://youtu.be/VIDEO_ID)

3. Adding Showcases

Showcases are managed in a data file.

  1. Go to src/data/showcaseData.js.
  2. You will see a list of items. To add a new one, copy an existing block (everything between { and },) and paste it as a new item.
  3. Update the text fields (companyName, whatIs, etc.).
  4. Images: Upload new images to src/assets and reference the filename in the image field.

4. Standard Pages

Standalone pages (like "About Us" or "Privacy Policy") are located in src/pages/.

  • Simple Page: Create a file like src/pages/new-page.md. It will be available at /new-page.
  • Page with Images: Create a folder like src/pages/new-page/ and add an index.md file inside.
    • You can then put images in that folder and link them using !Alt.

5. Contact Form

The contact form uses EmailJS.

If you need to change the email configuration (Service ID, Template ID, or Public Key):

  1. Go to src/containers/components/contactUs/Form.jsx.
  2. Look for the emailjs.sendForm function (around line 24).
  3. Update the IDs inside the quotes.

⚙️ Local Development (Optional)

If you are a developer and want to run the site on your computer:

  1. Install Node.js.
  2. Run npm install to install dependencies.
  3. Run npm start to start the local server.
  4. The site will open at http://localhost:3000.

About

docwire.io website

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •