mirror of https://github.com/fluffos/fluffos synced 2026-08-12 18:26:06 -04:00

Add local search and documentation guide for docs site (#1221 )

* docs: add local full-text search and a contributor README

Add @easyops-cn/docusaurus-search-local to the Docusaurus site so the
docs get an offline search bar (index built at build time, no external
service). English and zh-CN pages are both indexed, and matched terms
are highlighted on the target page.

Add docs/README.md describing the Docusaurus setup, local dev/build
commands, search behavior, directory layout, and gotchas; exclude it
from the published site alongside CLAUDE.md. Point the root README's
docs/ entry at it.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01TSzcESzU9947zkGzQ6SMmE

* docs: remove dead framework leftovers, fix index generation, complete the nav

Delete the VitePress (.vitepress/) and Jekyll (_layouts/, css/) leftovers,
the one-shot migration scripts (fix_md_header.py, fix_seealso.py), and the
stale keywords.json snapshot; prune the matching .gitignore entries and
docusaurus exclude patterns.

Rewrite gen_index.py for Docusaurus: it emitted dead .html links and
legacy 'layout: doc' frontmatter, choked on non-markdown entries, and
dropped nested categories — regenerating an index would have broken it.
It now emits the extension-less links the site actually uses, links
nested category indexes (restoring apply/* on the zh-CN index), and
refuses to run on the docs root. Fix update_index.sh's copy-paste titles
(zh-CN efun/build were titled 'APPLY'), stop it clobbering the
hand-written lpc/index.md, and cover cli/. Regenerated indexes pick up
the missing driver/ffi-plan entry. add_missing_efuns.py now takes the
keywords.json path as an argument instead of requiring a stale copy.

Move CNAME and the Google site-verification file into static/ so they
actually reach the published build output.

Complete the sidebar: link the CLI category to cli/index and add the
missing portbind/symbol/generate_keywords pages, and expose the
previously orphaned stdlib section under Reference.

Promote onBrokenLinks to 'throw' now the build is warning-free, and drop
the empty Demo section from the landing page.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01TSzcESzU9947zkGzQ6SMmE

* docs: strip legacy 'layout: doc' frontmatter from all pages

Mechanical sweep removing the Jekyll-era 'layout: doc' line from every
doc page's frontmatter (Docusaurus ignores it), and the matching line
from the templates in docs/CLAUDE.md so new pages don't reintroduce it.
No content changes.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01TSzcESzU9947zkGzQ6SMmE

---------

Co-authored-by: Claude <noreply@anthropic.com>

2026-07-09 22:09:55 -04:00

2.8 KiB

Raw Permalink Blame History

title
Build (v2017)

build_v2017

Environment

v2017 currently supports ubuntu 14.04+, centos 7+, CYGWIN 64.

Compilers: FluffOS uses C++11, which requires at least GCC 4.6+ or LLVM clang 3.0+.

Library: libevent 2.0+, additional libraries depends on the package selection.

jemalloc: use JEMALLOC is highly recommended in production. otherwise you may run into memory issue.

BUILD

To Build fluffOS v2017 (Autoconf & in tree build)

    # 0. You need to install autoconf & automake!
    $ sudo apt install autoconf automake
   
    # 1. checkout git repo
    $ git clone https://github.com/fluffos/fluffos.git
    $ cd fluffos
    $ git checkout v2017 (or any specfic release tag)

    # 2. modify local_options file as need.
    $ cd src
    <edit local_options to you need>

    # 3. Build!
    $ ./build.FluffOS
    $ make

    # 4. find the built binary in src/driver and src/portbind

CentOS

The problem with CentOS is that most of the package is too old for FluffOS, you must upgrade them manually first.

Move to ubuntu or run an ubuntu based docker images is highly recommended.

    # Install GCC 4.8 (or the latest one you like!)

    $ wget http://ftp.gnu.org/gnu/gcc/gcc-4.8.0/gcc-4.8.0.tar.bz2
    $ tar -jxvf  gcc-4.8.0.tar.bz2
    $ cd gcc-4.8.0
    $ ./contrib/download_prerequisites

    # Build GCC
    $ cd ..
    $ mkdir gcc-build-4.8.0
    $ cd gcc-build-4.8.0
    $../gcc-4.8.0/configure --enable-checking=release --enable-languages=c,c++ --disable-multilib
    $ make -j16 # (Will take an hour)
    $ make install

    # Verify now gcc is installed correctly.
    # "gcc -v" should output "gcc (GCC) 4.8.0"

    # NOTE:Manually install new version of libstdc++
    # you have to copy libstdc++.so.6 in your gcc4.8 build directory to /usr/lib64
    # override the existing file.

    # Install libevent2.0 manually

    $ wget https://github.com/downloads/libevent/libevent/libevent-2.0.21-stable.tar.gz
    $ tar zxvf libevent-2.0.21-stable.tar.gz
    $ cd libevent-2.0.21-stable
    $ ./configure –prefix=/usr
    $ make
    $ make install

CYGWIN32/CYGWIN64

FluffOS v2017 is fully functional under CYGWIN32 and CYGWIN64.

    # 1. Get CYGWIN setup file on http://www.cygwin.org , preferably x64 one.

    # 2. Make sure to install following packages, using apt-cyg
         (https://github.com/transcode-open/apt-cyg) is highly recommended. 

      - autoconf
      - automake
      - binutils (make sure to choose 2.28-3, there are still crashing bugs for latest version)
      - bison
      - gcc-core
      - gcc-g++
      - git
      - libcrypt-devel
      - libevent-devel
      - libiconv-devel
      - libpcre-devel
      - zlib-devel
      - libmysqlclient-devel

    # CYGWIN setup should take care of other dependencies for you

    # 3. Build FluffOS as if we are under normal linux!

2.8 KiB Raw Permalink Blame History Unescape Escape